springboot使用swagger3生成接口文档,最新UI界面

时间:2024-10-01 16:30:15
  • package ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • import ;
  • /**
  • * @author wenxiansheng
  • * @create 2022-11-27 18:00
  • */
  • @Configuration
  • @EnableOpenApi
  • public class Swagger3Config extends WebMvcConfigurationSupport {
  • @Override
  • public void addResourceHandlers(ResourceHandlerRegistry registry) {
  • ("", "")
  • .addResourceLocations("classpath:/META-INF/resources/");
  • ("/webjars/**")
  • .addResourceLocations("classpath:/META-INF/resources/webjars/");
  • }
  • /**
  • * 创建API应用
  • * apiInfo() 增加API相关信息
  • * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
  • * 本例采用指定扫描的包路径来定义指定要建立API的目录。
  • *
  • * @return
  • */
  • @Bean
  • public Docket restApi() {
  • return new Docket(DocumentationType.OAS_30)
  • .groupName("标准接口")
  • .apiInfo(apiInfo("Spring Boot中使用Swagger3构建RESTful APIs", "3.0"))
  • .useDefaultResponseMessages(true)
  • .forCodeGeneration(false)
  • .select()
  • .apis((""))
  • .paths(())
  • .build();
  • }
  • /**
  • * 创建该API的基本信息(这些基本信息会展现在文档页面中)
  • * 访问地址:http://localhost:8080/swagger-ui//
  • * 使用了第三方UI的访问路径为 http://localhost:8080//
  • *
  • * @return
  • */
  • private ApiInfo apiInfo(String title, String version) {
  • return new ApiInfoBuilder()
  • .title(title)
  • .description("更多请关注: /Lean_on_Me?type=blog")
  • .termsOfServiceUrl("/Lean_on_Me?type=blog")
  • .contact(new Contact("wenxiansheng", "/Lean_on_Me?type=blog", "1075753601@"))
  • .version(version)
  • .build();
  • }
  • }