当前位置: 首页 > 知识库问答 >
问题:

大摇大摆的UI——从编辑器中将JSON规范读入UI,而不需要宿主

印瑾瑜
2023-03-14

我试图通过在Swagger编辑器中编写文档然后将其加载到Swagger UI中使用Swagger来记录我的API。我使用编辑器并下载了我的 JSON 文件,然后使用以下命令将 UI 中的 /dist/index.html 文件更改为指向我的本地文件:

var spec = "file:///Users/user1/Desktop/swagger.json";

  if (url && url.length > 1) {
    url = decodeURIComponent(url[1]);
  } else {
    url = "http://petstore.swagger.io/v2/swagger.json";
  }

  // Pre load translate...
  if(window.SwaggerTranslator) {
    window.SwaggerTranslator.translate();
  }
  window.swaggerUi = new SwaggerUi({
    url: url,
    spec: spec,

我在该文件中唯一更改的是使用了spec var来指向我的JSON文件,但是当我打开UI时,它显示一个空白的UI页面,并显示消息“已完成加载资源信息”。正在渲染Swagger UI ... "我只想在UI中显示我在编辑器中创建的文档,而不需要托管规范,我遗漏了什么吗?

共有1个答案

袁宜民
2023-03-14

与文档一致,规范值必须是 JSON 对象,因此您必须执行如下操作:

window.swaggerUi = new SwaggerUi({
  spec: JSON.parse('{ "swagger": "2.0", ...')

在哪里

{ “swagger”: “2.0”, ...

您的网站的内容是什么file:///Users/user1/Desktop/swagger.json文件

 类似资料:
  • 我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息? 到目前为止,我已经用@ApiOperation注释了方法以显示in/out参数,并尝试使用@Authorization/@AuthorizationScope,但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti

  • SpringDoc 1.5.3(最新版本) SwaggerUI 3.41.0(最新版本) Swagger UI显示了的好字段。 我有一个POSTendpoint,所以我使用了。 我可以发送一个JSON,它解析成我的body对象。到目前为止还不错。 但是,Swagger UI只显示一个文本区域,我应该在其中放置整个JSON。这不太方便。 我希望Swagger UI为请求类的每个属性显示单独的字段;没

  • 我有一个java项目(tomcat webapp)和一些REST Api。我想为他们生成大摇大摆的文档。我从本教程(github)开始。我没有maven我们使用蚂蚁任务。我加入了swagger-annotations-1.5.0。jar和所有随swagger jaxrs jar 1.5.0版本附带的jar(如果有用的话,我可以包括一个完整的列表),我已经注释了一些方法,我有一个如下的配置类: }

  • 如果我在editor.swagger.io中粘贴以下规范: 描述以单行呈现: 即使 yaml 规范声明块样式字符串保留换行符:https://yaml-multiline.info/ 如何在swagger编辑器中使用多行字符串?

  • 编译得很好,但当我使用BootRun命令启动应用程序时,它失败了,原因是: 会有什么问题?不兼容Java9?那我能让它发挥作用吗?

  • 我是新手所以我可能错过了什么