使用Swagger文档向网站添加API文档

Question

我构建了一个基本网页，以及我的API的Swagger文档JSON文件。我不确定如何将文档中的数据实际添加到网站，以便可以浏览它。

我想为API构建托管文档。

这是Swagger给出的示例：http://petstore.swagger.wordnik.com/#!/pet/addPet

我是否只需下载Swagger UI并将其与JSON文件结合使用。

但我不确定要做到这一点。关于如何创建这样的东西的任何建议都会非常有用。

Answer 1

Swagger-ui基本上是一组静态文件，您可以在服务器上托管以显示您的API。

除非您有任何重大更改，否则您只需将/ dist文件夹的内容复制到您的服务器并将其作为应用程序的一部分（或静态网站，无关紧要）进行托管。

SwaggerUi对象可以根据您的需求进行自定义，包括您要托管的规范的网址。

请注意，如果您未在同一台服务器（即同一主机和同一端口）上托管ui和规范，则需要启用CORS。