SwaggerConfig.java 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. package com.ruoyi.framework.config;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import springfox.documentation.builders.ApiInfoBuilder;
  6. import springfox.documentation.builders.PathSelectors;
  7. import springfox.documentation.builders.RequestHandlerSelectors;
  8. import springfox.documentation.service.ApiInfo;
  9. import springfox.documentation.service.Contact;
  10. import springfox.documentation.spi.DocumentationType;
  11. import springfox.documentation.spring.web.plugins.Docket;
  12. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  13. /**
  14. * Swagger2的接口配置
  15. */
  16. @Configuration
  17. @EnableSwagger2
  18. public class SwaggerConfig {
  19. /** 系统基础配置*/
  20. @Autowired
  21. private RuoYiConfig ruoYiConfig;
  22. /**
  23. * 创建API
  24. * @return
  25. */
  26. @Bean
  27. public Docket createRestApi() {
  28. return new Docket(DocumentationType.SWAGGER_2)
  29. //详细定制
  30. .apiInfo(apiInfo())
  31. .select()
  32. //.apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.*.*.controller"))
  33. //扫描所有
  34. .apis(RequestHandlerSelectors.any())
  35. .paths(PathSelectors.any())
  36. .build();
  37. }
  38. private ApiInfo apiInfo() {
  39. // 用ApiInfoBuilder进行定制
  40. return new ApiInfoBuilder()
  41. .title("系统接口列表")
  42. .description("API接口测试平台\",\n" +
  43. " \"提供后台所有Restful接口\",")
  44. .termsOfServiceUrl("http://localhost/swagger-ui.html")
  45. .contact(new Contact(ruoYiConfig.getName(), "https://gitee.com/y_project/RuoYi", "1403014932@qq.com"))
  46. .version("1.1.0")
  47. .build();
  48. }
  49. }