如何从Swagger UI导出Swagger JSON / YAML文件?

sashoalm:

如何导出Swagger定义文件(它应该是JSON或YAML文件)?我被要求这样做,而我对Swagger仅有粗略的了解。

我们确实有一个http://example.com//swagger/ui/index#!看起来像这样的端点(尽管屏幕截图不是我们真正的端点,但是我无法发布该端点):

在此处输入图片说明

版本是api version: v1

我没有看到“导出”按钮。那么我该如何导出呢?

海伦:

API定义的URL显示在Swagger UI的顶部栏中–在您的示例中,它是

/v2/api-docs?group=full-petstore-api

因此,完整的网址似乎是

http://localhost:8080/v2/api-docs?group=full-petstore-api

在较新版本的Swagger UI中,API定义的链接通常显示在API标题下方,因此您可以右键单击该链接并另存为。

Link to API definition in Swagger UI 3.x


如果您的Swagger UI没有指向API定义的可见链接,请查看页面源并查找url参数,例如:

const ui = SwaggerUIBundle({
  url: "https://petstore.swagger.io/v2/swagger.json",     // <-------
  dom_id: '#swagger-ui',

如果你没有看到url,或者url是代码的表达,打开浏览器开发工具,切换到网络选项卡,禁用缓存。然后刷新页面,搜索API定义文件(swagger.jsonswagger.yamlapi-docsHTTP请求中或类似)。您可以按XHR筛选以缩小列表范围。

Finding the Swagger file on the Network tab of browser dev tools


有时,OpenAPI定义可能嵌入在.js文件中–在这种情况下,请使用此文件并去除多余的部分。

OpenAPI definition embedded in a JavaScript file

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

Swagger-UI和Ktor如何导入swagger.json或.yaml文件并启动Swagger-UI?

从Swagger文档生成Yaml或Json文件

如何过滤生成的Swagger JSON(yaml)

如何为包含许多Swagger定义.json / .yml文件的目录组织/构建Swagger UI界面

NestJS - Swagger JSON 导出

将Swagger端点导出为单个json文件

我将json文件导入swagger-editor,它会自动将其转换为yaml。我该如何预防?

如何使用带有 Flask 的静态 .yaml 文件生成 OpenAPI 文档(Swagger UI)页面?

如何生成swagger.json

如何定义Swagger 2.0 JSON以在Swagger UI中填充默认主体参数对象?

如何使用本地代码更改和我自己的swagger.json运行swagger-ui?

Swagger POST Json主体参数架构YAML

如何在Swagger-UI中打开本地文件

如何从JavaScript访问swagger Yaml定义的对象

扬鞭UI与SpringBoot swagger.yaml

如何在nodejs中的Swagger UI(swagger.json)中的标头中表示自定义令牌

如何从swagger.json删除反引号

如何在Java中以编程方式编辑swagger yaml文件以向REST端点添加请求参数?

如何使用swagger 3.x从源注释生成OAS yaml文件?

生成Swagger.json文件后,如何以编程方式访问它

如何使用Swashbuckle的SwaggerUI显示静态的swagger.json文件,而不是SwaggerGen的动态创建的定义?

如何将外部swagger json文件链接到Python FastAPI?

来自现有JSON的Springfox Swagger Ui

显示 Swagger.json 但 UI 不显示

在Swagger UI中美化Json响应

Swagger ui 无法在服务器中加载 json 规范文件

Swagger - 配置 JSON 文件 C#

swagger JSON文件上的空值

将Swagger Java对象转换为JSON / YAML