如何从.json描述符文件生成API文档?

时间:2015-07-09 14:01:12

标签: json node.js api

我使用Restlet studio生成了node.js应用程序框架。这个骨架包含一个swagger2.json定义文件,其中包含了我想要的所有API信息。是否有任何直接的方式以更易读的格式将这些信息显示为文档?我已经研究过并发现了像swagger.io这样的东西,虽然看完了文档,但还不太清楚如何使用它。

编辑:我将dist文件夹中的所有文件复制到我的根应用程序文件夹中,然后修改了index.html

var url = window.location.search.match(/url=([^&]+)/);
  if (url && url.length > 1) {
    url = decodeURIComponent(url[1]);
  } else {
    url = "json/swagger2.json"; //I replaced here with my json
  }

然而,当我在浏览器中启动它时,我得到的只有:

Please specify the protocol for file:///home/osboxes/Desktop/nodejsServerSkeleton_3/index.html/json/swagger2.json

换句话说,我可以为本地swagger.json文件执行此操作吗?或仅限公共资源?

0 个答案:

没有答案