Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/node.js/34.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Node.js Swagger生成UI文档JSON提要_Node.js_Swagger - Fatal编程技术网

Node.js Swagger生成UI文档JSON提要

Node.js Swagger生成UI文档JSON提要,node.js,swagger,Node.js,Swagger,我正在使用Node.js和Swagger构建一个restful API。Swagger UI(此处的演示链接)需要一个JSON提要 如何基于Swagger spec yaml文件生成此提要?难道没有一个npm模块可以迭代yaml文件并生成JSON提要吗?我是个新手,所以我可能忽略了一些东西。现在,Swagger UI应该支持YAML了。您可以使用库将YAML转换为JSON。您还可以使用Swagger编辑器: 我不能说我以前试过,但你可以上传YAML并导出为YAML或JSON 我以前用过这个编辑

我正在使用Node.js和Swagger构建一个restful API。Swagger UI(此处的演示链接)需要一个JSON提要


如何基于Swagger spec yaml文件生成此提要?难道没有一个npm模块可以迭代yaml文件并生成JSON提要吗?我是个新手,所以我可能忽略了一些东西。

现在,Swagger UI应该支持YAML了。您可以使用库将YAML转换为JSON。

您还可以使用Swagger编辑器:

我不能说我以前试过,但你可以上传YAML并导出为YAML或JSON

我以前用过这个编辑器,我真的很喜欢它

编辑:

因此,为了设置swagger ui,我执行了以下操作:

var swaggerUi = new SwaggerUi({
  url:"http://petstore.swagger.io/v2/swagger.json",
  dom_id:"swagger-ui-container"
});

swaggerUi.load();
这来自这里:

我想你得到了那个角色

至于doc(YAML或JSON),只需从您的站点提供它即可。如果您在nodejs服务器上使用express,只需静态提供文件:

因此,在本例中,如果您将swagger.json文件放在public dir的正下方,您可以通过以下方式访问它:

http://<yoursite>/swagger.json
http:///swagger.json

只要测试一下,你就可以从浏览器中的url访问你的招摇过市的文档。当您设置swagger ui时,将该URL放入上面的“URL”参数中,您应该可以开始了。Swagger ui将为您完成其余工作,它将从您的站点中提取json或yaml定义,并生成交互式文档站点。

我了解Swagger ui的工作原理,但如何生成进入Swagger ui的json提要?我正在寻找一些节点中间件,它解析Swagger yaml/json文件并生成UI文档feedAh,我明白了。对不起,我弄糊涂了。我可以更新答案,看看这是否有帮助。我在工程方面做得太多了。您不需要任何中间件。Swagger UI可以直接使用yaml或json中的Swagger规范文件。我试过这样做。在我的应用程序var swaggerUi=newswaggerui({url:,dom_id:“swagger ui container})中,我一直停留在导入swagger ui的层次上;load();我得到一个错误,说大摇大摆是没有定义的!!!有什么帮助吗?你完全正确,莫森!我已经在localhost上测试过了,Swagger用户界面确实支持一个格式良好的Swagger规范文件。yaml和json都受支持,因此不需要转换。
http://<yoursite>/swagger.json