沙田镇网站仿做,阎良网站建设,网站备案 广东,深圳app客户端做网站文章目录 前言一、SpringDoc是什么#xff1f;二、使用步骤1.引入库2.配置类3.访问测试 总结其他配置立个Flag 前言 之前常用的SpringFox在2020年停止更新了#xff0c;新项目集成SpringFox出来一堆问题#xff0c;所以打算使用更活跃的SpringDoc#xff0c;这里简单介绍一… 文章目录 前言一、SpringDoc是什么二、使用步骤1.引入库2.配置类3.访问测试 总结其他配置立个Flag 前言 之前常用的SpringFox在2020年停止更新了新项目集成SpringFox出来一堆问题所以打算使用更活跃的SpringDoc这里简单介绍一下我这边SpringBoot2.6.6集成SpringDoc1.6.9的demo。 一、SpringDoc是什么
官网链接
二、使用步骤
1.引入库
maven为例
dependencygroupIdorg.springdoc/groupIdartifactIdspringdoc-openapi-ui/artifactIdversion1.6.9/version
/dependency2.配置类
代码如下示例
package com.yhcookie.demo.config; import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** OpenAPI swagger 配置** author yhcookie* date 2023-08-25*/
Configuration
public class OpenApiConfig {/*** 配置API信息* return*/Beanpublic OpenAPI demoOpenAPI() {return new OpenAPI().info(new Info().title(YHCookie API).description(springDoc demo API).version(v1.0.0)// 若想增加其他API信息项可参考官网);}/*** 配置过滤规则* 若不配置该GroupedOpenApi, 默认扫描所有接口并生成文档* return*/Beanpublic GroupedOpenApi demoGroupedOpenApi() {return GroupedOpenApi.builder().group(group1) // 分组名可建多个不同分组分别扫描不同位置接口.pathsToMatch(/controller1/**)// 接口过滤据此增加接口扫描规则扫描Operation注解标注的接口。想皮一下的话亦可自定义注解.addOpenApiMethodFilter(method - method.isAnnotationPresent(Operation.class)) .build();}
}3.访问测试
默认路径 UI界面 http://localhost:9527/swagger-ui/index.html json界面 http://localhost:9527/v3/api-docs UI的展示其实就是读取该json展示的 总结
我这边也是刚用不久使用中有问题可以在这交流一下。
其他配置
# 是否启用默认启用生产可配置false关闭
springdoc.swagger-ui.enabledtrue
# UI界面
springdoc.swagger-ui.path/swagger-ui.html立个Flag
翻译一下官方文档…
