保举一款接口 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 来应用拭魅战。

【编辑保举】

1. 小米在 Github 上开源小米 9 的内核源代码
2. 10个Java开拓职员的顶级测试器材、库和框架先容
3. 锤子开源 Smartisan T1/T2、坚果 Pro 等手机内核源代码
4. iOS 12全版本越狱器材宣布：最高支持iPhone X
5. 小米盒子3内核代码已开源，坐等刷机包？

【责任编辑：张燕妮 TEL：（010）68476606】
点赞 0

（编辑：河北网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!