Swagger Fly Swagger Fly

JSON 文件(使用UTF8编码)


JSON 文本(使用UTF8编码)



JSON URL(必须允许跨域访问【CORS】)

  • 根据 OpenAPI 规范在线生成漂亮的 PDF 文档;
  • 支持 Swagger 2.0 和 OpenAPI 3.0;
  • 纯前端组件生成PDF,不收集您任何文档信息;
  • 支持 Chrome、FireFox、Safari、Edge 浏览器;
  • 请耐心等待核心包加载(gzip压缩后约2.4MB,不同地区加载时间从数秒至一分钟);

对于JAVA WEB用户,完美支持 Springfoxspringdoc-openapi,JSON 文档地址一般分别是 http://ip:port/v2/api-docs/ 和 http://ip:port/v3/api-docs/ 。

示例(下载轻舟的json文件,生成PDF文档)

轻舟是一个基于 Spring Boot 开发的 Java Web 基础支撑框架,使用 springdoc-openapi 来生成在线文档:qz.json

Swagger是什么?

Swagger是一个帮助REST API开发的工具。使用Swagger,可以简化你的API设计,开发以及调试。 其中Swagger规范定义了创建API的RESTFUL约定,基于JSON格式,易于阅读。 swagger-ui用于可视化和测试OpenAPI+swagger定义的 Web界面。 Swagger规范目前流行的版本是 Swagger 2.0Open API 3.0 名称发生变化是因为它被捐献给了Linux基金会(2015 年,根据 OpenAPI 倡议,OpenAPI 规范捐赠给 Linux 基金会。该规范通过有效映射与 API 相关的所有资源和操作,创建一个易于开发和消耗 API 的 RESTful 接口)。 3.0相比2.0,采用了更模块化和可重复使用的方法来定义 API,在描述请求响应模型和基础安全信息时,它更强大。 所以,如果你有新的项目打算使用swagger,建议使用最新的Open API 3.0规范。

JAVA WEB程序如何使用Swagger?

JAVA WEB领域的半壁江山都被Spring家族所占据,所以,本问题下将回答Spring Boot程序如何使用Swagger。 目前适配Spring Boot自动生成Swagger规范的主流库有两个,分别是 springdoc-openapispringfox。二选一,在工程中引入即可使用(轻舟使用的是springdoc-openapi)。