【问题标题】:use django-rest-swagger 2 with custom swagger.json将 django-rest-swagger 2 与自定义 swagger.json 一起使用
【发布时间】:2017-01-22 03:28:18
【问题描述】:

我有一个使用 django-rest-framework 构建的项目,我想使用 django-rest-swagger 来获取 API 文档,所以我通过 swagger 编辑器制作了一个 swagger.json 文件,那么我的问题是:

如何让 django-rest-swagger 读取并渲染我自己的 swagger.json,而不是从代码中自动生成?

我一遍又一遍地检查了 django-rest-swagger 文档,但没有发现任何相关内容。

任何评论将不胜感激。

【问题讨论】:

    标签: django django-rest-framework django-swagger


    【解决方案1】:

    我知道这是旧帖子,但我遇到了同样的问题并想提供我的解决方法。

    如果您尝试从外部 JSON 创建 Swagger UI,这是我的工作。我正在使用 django,但想提供另一个框架和服务器的 swagger api。这里有两个选项:

    1. 最简单的解决方案是手动渲染 swagger html 模板并在 SwaggerUi() 中插入提供 JSON 的端点 url,这通常位于最后一个块中。
    2. 或者,如果您无法直接访问 json 或拥有静态文件,请创建自己的 rest 端点来读取文件或向远程服务器发出请求,然后自己提供所需的 JSON。在您的 swagger 模板中引用此端点。

    【讨论】:

    • 谢谢@Deron Smith,我找到了解决方案,只需使用 swagger 编辑器在 YAML 中编写 API 文档,然后使用 swagger-ui 提供文件,简单且可自定义。
    • @TomYoung 你能详细说明一下吗?
    猜你喜欢
    • 2013-06-08
    • 1970-01-01
    • 2022-08-18
    • 2016-11-25
    • 1970-01-01
    • 2016-01-26
    • 2019-12-23
    • 2021-09-11
    相关资源
    最近更新 更多