首页 文章

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

提问于
浏览
1

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

我想为API构建托管文档 .

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

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

但我不确定实现这一目标 . 关于如何创建这样的东西的任何建议都会非常有帮助 .

1 回答

  • 1

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

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

    SwaggerUi对象可以根据您的需要进行定制,包括您托管的规范的URL .

    请记住,如果您不在同一服务器上托管ui和spec(即相同的主机和相同的端口),则需要启用CORS .

相关问题