我正在尝试使用 Swagger UI，它说我应该首先编写一个描述 REST api 的确切 api 的 api-doc。问题是我不知道这意味着什么。这份文件是用简单的英文写的吗？或者是否有某种格式可以生成 UI？
谢谢！
问问题
2824 次
1 回答
5
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 对其进行可视化和测试。
于 2014-10-23T15:36:03.900 回答