推荐一款接口 API 设计神器!
今天栈长给大家推荐一款接口 API 设计神器,传说中的,牛逼哄洪的 Swagger,它到底是什么?今天为大家揭开谜底!
Swagger是什么?
官网:https://swagger.io/
Swagger 如官网所示,它是最好的 API 构建工具。
它是一个围绕 OpenAPI 规范构建的开源工具,它可以帮助我们设计、构建、记录和使用 REST API 接口。
Swagger 包含的主要套件:
- Swagger Editor - 基于浏览器的编辑器,用来编写 OpenAPI 规范。
- Swagger UI - 基于 OpenAPI 规范动态生成 API 规范文档。
- Swagger Codegen - 个模板驱动引擎,用来生成客户端代码。
图片来源见博客水印。
OpenAPI是什么?
上面有说到 Swagger 是一个围绕 OpenAPI 规范构建的开源工具,那么 OpenAPI 是什么呢?
OpenAPI 规范,以前叫 Swagger 规范。它是一个为 REST APIs的接口定义的规范。OpenAPI 可以定义的 API 实体内容包括以下几个部分。
- 请求地址(如:/user)
- 请求类型(如:GET、POST 等)
- 请求参数
- 响应参数
- 验证方式
- 文档信息:如联系人、许可证、服务条件等
这个 OpenAPI 规范可以用 YAML 或者 JSON 来编写,这种格式非常易于学习,可读性对开发人员非常友好。
完整的 OpenAPI 规范可以去官网看一下。
https://github.com/OAI/OpenAPI-Specification
编写文档地址:
http://editor.swagger.io/
为什么需要Swagger?
现在的互联网架构都是前后端分离的模式,还有现在是移动互联网时代了,APP 需要与后端服务器通信也需要维护一套接口,API文档自然就成了前后端开发人员联系的纽带。
编写 API 文档的方式也各有不同,有用 WORD 编写的,有用 confluence 等编写的,但这些方式都不能动态更新,每次接口变更都需要手动维护文档,甚是麻烦。有了 Swagger,可以先做完接口,通过 Swagger 来动态生成和更新 API 文档。
后面的文章会继续介绍如何使用 Swagger 注解来自动生成 API 文档,及如何集成 Spring Boot 来应用实战,关注Java技术栈微信公众号,在后台回复关键字 "工具" 可获取所有历史 Java 工具类文章教程及更新。
本文原创首发于微信公众号:Java技术栈(id:javastack),关注公众号在后台回复 "工具" 可获取更多,转载请原样保留本信息。
转载于:https://www.cnblogs.com/javastack/p/10404509.html
推荐一款接口 API 设计神器!相关推荐
- 接口 API 设计神器
给大家推荐一款接口 API 设计神器,传说中的,牛逼哄洪的 Swagger,它到底是什么?今天为大家揭开谜底! Swagger是什么? 官网:https://swagger.io/ Swagger 如 ...
- 推荐一款全能测试开发神器!1分钟快速上手!
关注上方"测试开发技术",选择星标, 干货技术,第一时间送达! 1. 说一下背景 在日常开发或者测试工作中,经常会因为下游服务不可用或者不稳定时,通过工具或者技术手段去模拟一个HT ...
- 黑科技:进阶必备,推荐两款自动生成代码神器
关注上方"测试开发技术",选择星标, 干货技术,第一时间送达! 最近两年,在互联网行业各大技术峰会上,都能看到关于工程效能这个概念,从侧面也反映出了研发效能已经逐渐被各企业所重视! ...
- 推荐一款万能抓包神器:Fiddler Everywhere
搞IT技术的同行,相信没有几个人是不会抓包这项技能的(如果很不幸你中枪了,那希望这篇文章给你一些动力),市面上的抓包工具也有很多,常用的有:Charles.Fiddler.Burpsuite.Wire ...
- 组件接口(API)设计指南-文件夹
组件接口(API)设计指南-文件夹 组件接口(API)设计指南[1]-要考虑的问题 组件接口(API)设计指南[2]-类接口(class interface) 组件接口(API)设计指南[3]-托付( ...
- 推荐12款精心设计网站设计PSD模板
为什么80%的码农都做不了架构师?>>> 日期:2012-4-18 来源:GBin1.com PSD网站设计模板在我看来,是非常有效的制作工具之一. 它可以用在很多方面.比如 ...
- 低代码开发,推荐一款Web 端自动化神器:Automa!
1. Automa介绍 又到了优秀工具推荐的时候了,今天给大家分享一款前端自动化操作神器: Automa. 首先了解一下Automa是什么?Automa它定位是一款 Chrome 插件,也就意味着,它 ...
- 低代码开发,推荐一款Web 端自动化神器:Automa
1. Automa介绍 又到了优秀工具推荐的时候了,今天给大家分享一款前端自动化操作神器: Automa. 首先了解一下Automa是什么? Automa它定位是一款 Chrome 插件,也就意味着, ...
- 推荐几款接口文档生成神器用来代替Swagger
前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在线文档 支持全文搜索 支持在线调试功能 界面优美 说实话,这个需求看起来简 ...
最新文章
- Worktile CTO 管理经验分享:如何在研发团队落地OKR?研发团队目标如何管理?
- sql PERCENTILE_CONT 计算一组数的线性差值
- 菜单 java_java 菜单
- MySQL 取得两个时间相差的分钟数 及 常用时间函数
- 数据库管理工具 Navicat使用教程:导航窗格提示和技巧 - 管理连接
- 美团java在线笔试题_美团点评春招在线笔试后台开发方向笔试题编程题第一题题解...
- 登录oneNote失败解决
- 计算机监控系统英文缩写,各弱电系统英文缩写
- html点击下载图片
- 《爱的五种能力》读书笔记22.02
- 驾驶员理论考试系统的设计与实现(论文+源码)_kaic
- Wallpaper (18)
- 职场中该如何自学?看书/看视频
- Windows Server 2008 R2 自定义桌面 图标
- BGP Aggregation – Suppress Map
- android sd卡获取不到,解决Android10读取不到/sdcard/、/storage/emulated/0/文件的问题
- 全国300城市交通违章查询api
- docker命令--k8s的日志
- Python 制作朋友圈高逼格的九宫格图片
- ERES BRES的区别
热门文章
- TinyWeb:C#中的简单Web服务器
- 国家计算机病毒中心发布违规 APP 和 SDK 名单
- weblogic控制台查看日志_weblogic 控制台日志保存到文件
- python登录验证程序_python – 测试Flask登录和身份验证?
- docker privileged作用_Docker 从入门到掉坑
- 人工智能在fpga的具体应用_新基建“芯”机遇,国产FPGA厂商如何抓住机会?
- 如何判断笔记本蓝牙硬件坏了_还在担心被套路?老司机教你如何判断车用尿素溶液的好与坏...
- eslint是什么_为什么eslint没有 no-magic-string?
- C++ Qt全局异常处理器_异常处理
- 过滤html标签 去除html标签