SwaggerApp.java 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. package com.springboot.staffingsystem.swagger;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import springfox.documentation.builders.ApiInfoBuilder;
  5. import springfox.documentation.builders.PathSelectors;
  6. import springfox.documentation.builders.RequestHandlerSelectors;
  7. import springfox.documentation.service.ApiInfo;
  8. import springfox.documentation.service.Contact;
  9. import springfox.documentation.spi.DocumentationType;
  10. import springfox.documentation.spring.web.plugins.Docket;
  11. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  12. @Configuration
  13. @EnableSwagger2
  14. public class SwaggerApp {
  15. @Bean
  16. public Docket createRestApi() {
  17. return new Docket(DocumentationType.SWAGGER_2)
  18. .apiInfo(apiInfo())
  19. .select()
  20. //为当前包路径
  21. .apis(RequestHandlerSelectors.basePackage("com.springboot.staffingsystem.controller"))
  22. .paths(PathSelectors.any())
  23. .build();
  24. // return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
  25. }
  26. //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
  27. private ApiInfo apiInfo() {
  28. return new ApiInfoBuilder()
  29. //页面标题
  30. .title(" StaffingSystem 使用 Swagger2 构建RESTful API")
  31. //创建人
  32. .contact(new Contact("ChenGengPeng", "http://blog.bianxh.top/", "1577992659@qq.com"))
  33. //版本号
  34. .version("1.0")
  35. //描述
  36. .description("API 描述")
  37. .build();
  38. }
  39. }