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

如何将OpenAPI.YAML规范公开到rest Spring Boot中

左丘边浩
2023-03-14
 @Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
            .components(new Components().addSecuritySchemes("basicScheme",
                    new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("basic")))
            .info(new Info().title("SpringShop API").version("0.1")
                    .license(new License().name("Apache 2.0").url("http://springdoc.org")))
            .externalDocs(new ExternalDocumentation()
                    .url("restapi/doc/openapi.yaml"));
}

    @Bean
    public SpringDocConfiguration springDocConfiguration(){
        return new SpringDocConfiguration();
    }
    @Bean
    public SpringDocConfigProperties springDocConfigProperties() {
        return new SpringDocConfigProperties();
    }

但我没有发现任何有用的东西。谢了。

    application.properties:
    springdoc.api-docs.enabled=false
springdoc.swagger-ui.url=openapi.yaml
springdoc.swagger-ui.path=/doc/api/ui.html

dependecies:
<dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.4.4</version>
    </dependency>

共有1个答案

杜骏祥
2023-03-14

第一个配置:外部OPENAPI定义

属性springdoc.swagger-ui.urls.*适合配置外部url(http://myhoost.com/v3/api-docs)

例如,如果您想在一个应用程序中商定其他服务的所有endpoint。不要忘记CORS也需要启用。

springdoc.swagger-ui.url=/openapi.yaml
 类似资料:
  • ThinkCMF5遵循PSR-2命名规范和PSR-4自动加载规范及 ThinkPHP5的开发规范,并且注意如下规范: URL规范 除 api的url,其它 url 不能以 api/开头 模板 assign 变量: 命名小写+下划线 每个 assign变量必须有一个名称 $this->assign('post', $post); 表单 name 命名: 小写+下划线 Controller,Mode

  • ThinkCMF完全按ThinkPHP开发规范进行 开发前请详细阅读: http://www.kancloud.cn/manual/thinkphp/1687 ThinkCMF特别开发规范 应用后台控件器放在应用Controller目录中,最好不要存放在Admin/Controller下,保证应用模块独立 应用后台控件器命名以****adminController.class.php或者Admin

  • ThinkCMF遵循PSR-2命名规范和PSR-4自动加载规范及 ThinkPHP5.1的开发规范,并且注意如下规范: URL规范 除 api的url,其它 url 不能以 api/开头 模板 assign 变量: 命名小写+下划线 每个 assign变量必须有一个名称 $this->assign('post', $post); 表单 name 命名: 小写+下划线 Controller,Mod

  • 命名规范 ThinkPHP5.1遵循PSR-2命名规范和PSR-4自动加载规范,并且注意如下规范: 目录和文件 目录使用小写+下划线; 类库、函数文件统一以.php为后缀; 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致; 类文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名; 类名和类文件名保持一致,统一采用驼峰法命名(首字母大写); 函数和类、属性命名 类的命

  • 下面将描述采用CI开发中的编码的规范. 内容列表 文件格式 PHP 闭合标签 类和方法的命名 变量命名 注释 常量 TRUE, FALSE, 和NULL 逻辑运算符 比较返回值和类型映射 调试代码 空行分割 兼容性 用常规词做类名和文件名 数据库表名 一个文件一个类 空白 断行 代码缩进 方括号及圆括号内的空格符 本地化文本 私有方法和变量 PHP 错误 短标签 每行一条语句 字符串 SQL 查询

  • 我找到了这个项目https://github.com/OAI/OpenAPI-Specification据我所知,我们可以用文件。而且,我能看到http://editor.swagger.io/它可以被渲染成文件。 我的问题是-我怎么能生成静态页面从文件?有任何教程的Spring引导应用程序吗?我应该以某种方式设置文件昂首阔步的配置和获得文件留档?