Rest 为Swagger编写api文档

Rest 为Swagger编写api文档,rest,swagger,swagger-ui,api-doc,Rest,Swagger,Swagger Ui,Api Doc,我正在尝试使用Swagger UI,它说我应该从编写一个api文档开始,该文档描述REST api的确切api。问题是我不知道这意味着什么。这份文件是用简单的英语写的吗?或者是否有某种格式可以生成UI 谢谢大家! Swagger是一种描述restapi的规范。规范的文档可在此处找到- 通常,有两种方法记录API。如果已经有一个包含代码的现有API,那么可以使用任何现有库()集成到代码中,并在运行时生成文档。其中一些库还提供此类文档的脱机生成 如果您希望设计一个API,或者不想将另一个库集成到您的

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


谢谢大家!

Swagger是一种描述restapi的规范。规范的文档可在此处找到-

通常,有两种方法记录API。如果已经有一个包含代码的现有API,那么可以使用任何现有库()集成到代码中,并在运行时生成文档。其中一些库还提供此类文档的脱机生成

如果您希望设计一个API,或者不想将另一个库集成到您的应用程序中,那么您可以在本地或与在线版本一起使用

一旦有了文档,就可以使用Swagger UI对其进行可视化和测试