我正在尝试使用Swagger UI，并且它说我应该先编写一个api-doc，描述REST api的确切api。问题是我不知道这意味着什么。这个文档是用普通英语写的吗？还是有一种特定的格式可以生成UI？
谢谢！
谢谢！
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来可视化和测试它。
通常有两种方法来记录您的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来可视化和测试它。
- Ron
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接