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

spingdoc openapi与webflow:显示自定义json/yml文件而不是生成的文件

狄冠宇
2023-03-14

我有一个简单的服务描述文件open-api.json:

{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "paths": {
    "/agents/{id}/plugins": {
      "post": {
        "tags": [
          "api-controller"
        ],
...
  },
  "components": {}
}

我在我的Spring webflux项目中使用springdoc openapi webflux ui:

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-webflux-ui</artifactId>
            <version>1.4.0</version>
        </dependency>

是否可以显示现有文件而不是生成的文件?任何帮助,谢谢!

共有2个答案

漆雕深
2023-03-14

好的,这就是你需要的。

  1. 在您的src/main/Resources目录中,创建一个名为静态的目录。在里面放置您的open-api.json文件。(注意-json文件的名称可以是任何东西)[这是一个示例open api spec json文件]
  2. 在应用程序yaml中添加此属性:
springdoc:
  swagger-ui:
    configUrl: /open-api.json

然后启动应用程序并点击URLhttp://localhost:8080/swagger-ui.html

请注意,如果存在Spring Security性,则需要额外的配置。

仰城
2023-03-14

如果您的文件包含 OpenAPI 3 格式的 OpenAPI 文档。然后简单地声明:(文件名可以是你想要的任何东西,从你的声明一致的那一刻起)

springdoc.swagger-ui.url=/open-api.json

然后文件打开api。json,应该位于:src/main/resources/static

无需其他配置

属性springdoc.swagger-ui。configUrl可以用于此处讨论的不同用途,因为其结构与

  • https://github.com/springdoc/springdoc-openapi/issues/686
 类似资料:
  • 我对招摇、合同和Spring启动(gradle)项目不熟悉,我们刚刚开始处理合同。我用过grails,喜欢你如何把field def放在域中,它通过堆栈继承。 一个具体的问题,也许还有一个背着猪的八卦问题。 如何从标准控制器类生成YAML文件的基本存根? 我知道我应该创建一个[Name]-v1-0。目录 我已经实现了大摇大摆的用户界面。项目中的html和一个非常酷的交互式网页出现,显示请求的结束点

  • 在PyCharm中,是否可以为文件定义语法高亮的自定义规则,这些规则结合了两种不同语言的语法? 一个有点做作的例子:以下文件应被视为HTML,脚本标记中的文本除外,脚本标记应视为Python代码。 让代码完成工作的加分。 注意“IntelliLang”扩展特性并不合适,因为在第二个块中,它看不到前面块中声明的变量。

  • 我正在尝试使用openssl为中间CA生成一个证书,该证书由我自己的根CA签名。根ca证书是v3,但当我尝试为中间-ca生成csr时,openssl总是生成v1证书,该证书也不允许签署其他证书。 用于生成签名证书的命令(用于中间ca): openssl X509-REQ-Days 365-IN REQEST.CSR-CA CA-ROOT.PEM-CAKEY CA-KEY.PEM-CACREATES

  • 文件:/springboot1_firstwebapp/pom.xml

  • 我的控制器正在响应: “{\”firstname\“:\”firstname required\“,\”lastname\“:\”lastname required\“,\”password\“:\”password required\“,\”matchingpassword\“:\”matchingpassword required\“,\”email\“:\”email required\“}

  • 我用spring boot和gradle制作了一个web服务。我的项目正在使用gradle。我必须做一个动态的web项目,集成UI和web服务。如何更新web服务,使其生成WAR文件而不是JAR文件??