json格式生成器_Springboot OpenAPI文档生成器Swagger

一、Swagger介绍

Swagger是一个开源文档生成器，可以方便的用来生成OpenAPI规格的接口文档，支持Go、Python、Haskell、Java等多种语言，同时支持在线调试接口。

官网：
https://swagger.io

Swagger 工具集包含：
• Swagger Editor – 在线编写 OpenAPI 规范的编辑器
• Swagger UI – 使用 OpenAPI 规范生成的交互式文档
• Swagger Codegen – 使用 OpenAPI 规范分别生成客户端/服务器代码(Server-stub)的工具

同类型的工具还有：

• docway

附：OpenAPI 中文文档：https://fishead.gitbooks.io/openapi-specification-zhcn-translation/content/versions/3.0.0.zhCN.html#oasDocument

二、java下的使用

1. 加入依赖

在Springboot环境下的使用十分简单，只需要加入依赖：

        ![在这里插入图片描述](https://img-blog.csdnimg.cn/20200927135341240.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3h1bmRo,size_16,color_FFFFFF,t_70#pic_center)            io.springfox            springfox-swagger-ui            2.5.0

2. 书写