springdoc openapi使用解决方案

 更新时间:2024年04月22日 09:57:49   作者:qq_44209563  
SpringDoc注解的使用,它是基于OpenAPI 3和Swagger 3的现代化解决方案,相较于旧版的Swagger2即SpringFox,SpringDoc提供了更简洁、更直观的注解方式,这篇文章主要介绍了springdoc openapi使用,需要的朋友可以参考下

什么是SpringDoc

SpringDoc注解的使用,它是基于OpenAPI 3和Swagger 3的现代化解决方案,相较于旧版的Swagger2(SpringFox),SpringDoc提供了更简洁、更直观的注解方式。

一、引入pom

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

二、新增配置类OpenApiConfig

@Configuration
public class OpenApiConfig {
    @Bean
    public OpenAPI springShopOpenAPI() {
        OpenAPI openAPI = new OpenAPI()
                .info(new Info().title("制品中心 后台服务API接口文档")
                        .description("restful 风格接口")
                        .version("v0.0.1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("SpringShop Wiki Documentation")
                        .url("https://springshop.wiki.github.org/docs"));
        return openAPI;
    }
    @Bean
    public OperationCustomizer customGlobalHeaders() {
        //设置全局请求头参数
        return (Operation operation, HandlerMethod handlerMethod) -> {
            Parameter tokenParam = new Parameter()
                    .in(ParameterIn.HEADER.toString())
                    .schema(new StringSchema())
                    .name("sessionid")
                    .description("sessionid")
                    .required(true);
            operation.addParametersItem(tokenParam);
            return operation;
        };
    }
}

全局请求头参数设置参考文章:

https://stackoverflow.com/questions/63671676/springdoc-openapi-ui-add-jwt-header-parameter-to-generated-swagger

三、Controller层示例

@Controller
@RequestMapping("/test")
@Tag(name = "测试接口")
@Validated
public class TestController {
    @Autowired
    private ArtifactService artifactService;
    @PostMapping("/v1/test")
    @Operation(summary  = "设置制品库权限")
    @NoPermission
    public Result<Void> addArtifactPermission(@Validated @RequestBody AssetAuthDataDTO assetAuthData, @RequestHeader(value = "adminaction", defaultValue = "false") boolean adminAction) {
        return null;
    }
    @Operation(summary = "添加", description = "添加描述",
            security = { @SecurityRequirement(name = "sessionid")},
            responses = {
                    @ApiResponse(description = "返回信息", content = @Content(mediaType = "application/json")),
                    @ApiResponse(responseCode = "400", description = "返回400时候错误的原因")
            }
    )
    @Parameters({
            @Parameter(name = "name", description = "名字", required = true),
            @Parameter(name = "typeId", description = "类型ID", required = true)
    })
    @PutMapping("add")
    @NoPermission
    public Result<Void> add(String name, String typeId) {
        return null;
    }
    /**
     * 查询generic制品库下所有文件列表
     *
     * @param quest 请求参数
     *
     * @return
     *
     * @author wangsb9
     * @data: 2023/4/6 14:54
     */
    @ApiOperation(value = "查询generic制品库下所有文件列表", httpMethod = "GET")
    @GetMapping("/v1/generic/item/list")
    @ResponseBody
    @RepoKeyPermission(permission = "read", param = "quest.repoKey")
    public Result<GenericItemListVO> getGenericItemList(GetGenericItemListQuest quest) {
        if (ArtifactTypes.GENERIC.equalsIgnoreCase(BusinessUtils.getArtifactTypeFromRepoKey(quest.getRepoKey()))) {
            GenericItemListVO vo = artifactService.geGenericItemList(quest);
            return Result.success("获取当前generic制品库包含的制品成功", vo);
        } else {
            return Result.failed("请求路径非generic库路径");
        }
    }
}

四、配置文件新增内容

application.yaml

springdoc:
  swagger-ui:
    # swagger-ui地址
    path: /swagger-ui/index.html
    enabled: true
    # 修复Failed to load remote configuration.
#    To configure, the path of a custom OpenAPI file . Will be ignored if urls is used
    url: /springdoc/api-docs
#  For custom path of the OpenAPI documentation in Json format.
  api-docs:
    path: /springdoc/api-docs
#  packages-to-scan: com.srdcloud.artifact.controller

五、验证

启动项目后访问地址http://<serviceIp>:<port>/swagger-ui/index.html

在这里插入图片描述

展示接口页面表示成功

到此这篇关于springdoc openapi使用的文章就介绍到这了,更多相关springdoc openapi使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • xxl-job的部署及springboot集成使用示例详解

    xxl-job的部署及springboot集成使用示例详解

    XXL-Job是一个分布式任务调度平台,可进行任务调度、管理和监控,并提供任务分片、失败重试、动态分配等功能,这篇文章主要介绍了xxl-job的部署及springboot集成使用,需要的朋友可以参考下
    2023-06-06
  • Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    这篇文章主要为大家详细介绍了Spring Bean生命周期之Bean元信息的配置与解析阶段,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java基础知识精通各种运算符

    Java基础知识精通各种运算符

    计算机的最基本用途之一就是执行数学运算,作为一门计算机语言,Java也提供了一套丰富的运算符来操纵变量,本篇对大家的学习或工作具有一定的价值,需要的朋友可以参考下
    2022-04-04
  • java实现切图并且判断图片是不是纯色/彩色图片

    java实现切图并且判断图片是不是纯色/彩色图片

    本篇文章主要介绍了java实现切图并且判断图片是否是纯色/彩色图片,具有一定的参考价值,有兴趣的可以了解一下
    2017-08-08
  • Java实战之实现用户登录

    Java实战之实现用户登录

    这篇文章主要介绍了Java实战之实现用户登录,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • java web实现自动登录

    java web实现自动登录

    这篇文章主要为大家详细介绍了java web实现自动登录,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • Java通过wait()和notifyAll()方法实现线程间通信

    Java通过wait()和notifyAll()方法实现线程间通信

    这篇文章主要为大家详细介绍了Java通过wait()和notifyAll()方法实现线程间通信的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • springboot操作静态资源文件的方法

    springboot操作静态资源文件的方法

    这篇文章主要介绍了springboot操作静态资源文件的方法,本文给大家提到了两种方法,小编在这里比较推荐第一种方法,具体内容详情大家跟随脚本之家小编一起看看吧
    2018-07-07
  • SpringBoot实现文件上传与下载功能的详细教程

    SpringBoot实现文件上传与下载功能的详细教程

    在日常开发中,文件上传和下载是非常常见的功能场景,比如用户头像上传、文档下载、附件管理等,本文将基于 SpringBoot 框架,实现一套简洁、通用、可直接上线使用的文件上传与下载接口,需要的朋友可以参考下
    2026-05-05
  • Nacos多个实例的服务调用失败问题及解决

    Nacos多个实例的服务调用失败问题及解决

    在微服务开发中,Nacos上出现多个同一服务实例导致OpenFeign调用失败,因为OpenFeign使用SpringCloudLoadbalancer,而SpringCloudLoadbalancer的底层默认负载均衡策略不支持Nacos,通过将负载均衡策略设置为Nacos,可以解决调用失败的问题
    2026-02-02

最新评论