【发布时间】：2014-10-22 19:25:09
【问题描述】：
我正在尝试使用 Swagger UI，它说我应该首先编写一个描述 REST api 的确切 api 的 api-doc。问题是我不知道这意味着什么。这份文件是用简单的英文写的吗？或者是否有某种格式可以生成 UI？
谢谢！
【问题讨论】：
标签： rest swagger swagger-ui api-doc
【发布时间】：2014-10-22 19:25:09
【问题描述】：
Swagger 是用于描述 REST API 的规范。可以在此处找到规范文档 - https://github.com/swagger-api/swagger-spec。
通常，有两种方法可以记录您的 API。如果您已经拥有包含代码的现有 API，则可以使用任何现有库 (https://github.com/swagger-api/swagger-spec#additional-libraries) 集成到您的代码中并在运行时生成文档。其中一些库还提供此类文档的离线生成。
如果您希望设计 API，或者不想将其他库集成到您的应用程序中，您可以在本地使用 https://github.com/swagger-api/swagger-editor 或使用在线版本 - http://editor.swagger.io。
获得文档后，您可以使用 Swagger UI 对其进行可视化和测试。
【讨论】：