开发者在开发 REST API 时一般会生成 Swagger 制作的 Open API 页面。这个页面虽然包含了所有的 API 使用信息,但是它是为测试 API 用的,不能用做 API 文档。
开发者可以使用下面的步骤来生成 PDF 文档:
- 下载 open api 的 json 文件
点击下图红线上方的链接就可以下载
-
把 json 内容粘贴到 http://editor.swagger.io 网页提供的编辑器里
-
选择 Generate Client ,类型选择 html
-
打开 html 然后选择打印为 pdf 即可生成 API 文档了