pom直接引用springfox-boot-starter,swagger3不需要引用ui包。
<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency>
开始相关配置,创建config配置类。
importorg.springframework.context.annotation.Bean; importorg.springframework.context.annotation.Configuration; importspringfox.documentation.builders.ApiInfoBuilder; importspringfox.documentation.builders.PathSelectors; importspringfox.documentation.builders.RequestHandlerSelectors; importspringfox.documentation.oas.annotations.EnableOpenApi; importspringfox.documentation.service.ApiInfo; importspringfox.documentation.spi.DocumentationType; importspringfox.documentation.spring.web.plugins.Docket; /*** @author lhq*/publicclassSwaggerConfig { publicDocketcreateRestApi() { returnnewDocket(DocumentationType.OAS_30) .apiInfo(buildApiInfo()) .enable(true) .select() // 要扫描的API(Controller)基础包 .apis(RequestHandlerSelectors.basePackage("com.hsrc.fjyc.intelligentassistant.controller")) .paths(PathSelectors.any()) .build(); } privateApiInfobuildApiInfo() { returnnewApiInfoBuilder() .title("stoneAPI文档") .description("平台管理服务api") .version("1.0.0") .build(); } }
注意:new Docket(DocumentationType.OAS_30)这里不再使DocumentationType.SWAGGER_2,从swagger2切换过来的一定小心,不然可能无法识别相关请求,加载一个空页面。
注解使用:@Tag代替@Api,其中name的值一定是类名小写,类名中间存在大写的用横线间隔开,大写变小写。
/*** 会话相关* @author lhq*/description="会话相关",name="chatbot-controller") (publicclassChatbotController { privateLoggerlogger=LogManager.getLogger(ChatbotController.class); AlibabaUtillalibabaUtill; JwtUtiljwtUtil; summary="获取热点(大家都在看)") ( ({ responseCode="200",description="成功",ref="成功"), (responseCode="400",description="失败",ref="失败") ( }) "/hotKnowledge") (publicStringhotKnowledge( (name="token",description="调用请求的令牌;",required=true) (value="token")Stringtoken, name="limit",description="总条数",required=true) (value="limit") Stringlimit){ (
这时候直接访问时注意,要带完整的路径/swagger-ui/index.html。否则可能找不到,想要可以直接输入/swagger-ui就可以访问,需要配置拦截,对/swagger-ui路径,直接跳转到/swagger-ui/index.html。