为Swagger编写api-doc

Question

我正在尝试使用Swagger UI，它说我应该首先编写一个api-doc来描述REST api的确切api。 问题是我不知道这意味着什么。 这份文件是用简单的英文写的吗？ 或者是否有某种格式可以生成UI？

谢谢！

Answer 1

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进行可视化和测试。