如何利用 Swagger 消除前后端分离的障碍

以前前后端协作的方式

1. 后端丢个接口的契约代码给你
2. 后端写到wiki里，代码更新，文档更新不及时

Swagger

Swagger 是很多产品的总称。包含最核心的规范 Swagger Specification，编辑器 Swagger Editor，图形界面 Swagger UI，代码生成器 Swagger Codegen，成熟的产品 SwaggerHub 等。

Swagger 的主要作用是描述 RESTful API，生成交互式文档，便于前后端开发人员查看请求信息和响应数据。

我们目前常用 Swagger 的版本为 Swagger 2.0

写Swagger配置文件

1. 代码注解生成
   Spring Boot集成Swagger
   如今，Swagger 与 Spring Boot 的无缝对接，简直就是不愿写文档的猿类的福音。
   http://blog.didispace.com/springbootswagger2/

2. 手动编写 Swagger 规范

• YAML 格式
• JSON格式

这一步，输出的是一个文档的URL地址，和一个JSON/YAML格式的Swagger文件。

前端导入Swagger文档，生成MOCK服务

1. easymock
   大搜车出品 输入Swagger文档地址，就可生成接口
   https://easy-mock.com
2. Yapi
   去哪儿出品
   https://yapi.ymfe.org/

参考

• https://mp.weixin.qq.com/s?src=11&timestamp=1511263504&ver=528&signature=EXVaq808-UUmgroGmo5PWJ7aIqwQf6xLqiywTDOdSSibMsnLyr5BsAxtQZD4nV0tgMGlJskj3vHn7b1FeXx0w2DNjXCdImciv3TNaQdx3CxRoC0Y35t7efFwyxfgvM&new=1