当前位置:   article > 正文

Springboot集成Swagger-ui完美方案,不显示api解决_swagger中没有不同的api可 选

swagger中没有不同的api可 选
  1. 建立maven项目,导入依赖
  1. <!--加入springboot-->
  2. <parent>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-parent</artifactId>
  5. <version>2.1.3.RELEASE</version>
  6. <relativePath />
  7. </parent>
  8. <!--JDK版本-->
  9. <properties>
  10. <java.version>1.8</java.version>
  11. </properties>
  12. <dependencies>
  13. <!--Springboot web和测试依赖 -->
  14. <dependency>
  15. <groupId>org.springframework.boot</groupId>
  16. <artifactId>spring-boot-starter-web</artifactId>
  17. </dependency>
  18. <dependency>
  19. <groupId>org.springframework.boot</groupId>
  20. <artifactId>spring-boot-starter-test</artifactId>
  21. <scope>test</scope>
  22. </dependency>
  23. <!-- 有更改时重新启动springboot方便调试-->
  24. <dependency>
  25. <groupId>org.springframework.boot</groupId>
  26. <artifactId>spring-boot-devtools</artifactId>
  27. <scope>runtime</scope>
  28. </dependency>
  29. <!-- swagger2依赖 -->
  30. <dependency>
  31. <groupId>io.springfox</groupId>
  32. <artifactId>springfox-swagger2</artifactId>
  33. <version>2.5.0</version>
  34. </dependency>
  35. <dependency>
  36. <groupId>io.springfox</groupId>
  37. <artifactId>springfox-swagger-ui</artifactId>
  38. <version>2.5.0</version>
  39. </dependency>
  40. <dependency>
  41. <groupId>io.springfox</groupId>
  42. <artifactId>springfox-staticdocs</artifactId>
  43. <version>2.5.0</version>
  44. </dependency>
  45. </dependencies>

2. 建立springboot启动类

  1. package com.tpdog.app;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  5. @SpringBootApplication
  6. @EnableSwagger2
  7. public class TpdogApp {
  8. public static void main(String[] args) {
  9. SpringApplication.run(TpdogApp.class, args);
  10. System.out.println("springboot启动成功");
  11. }
  12. }

建立swagger2配置类

  1. package com.tpdog.app;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.ComponentScan;
  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. @ComponentScan("com.tpdog.controller")//需要扫描的api位置
  14. @Configuration//说明是一个配置类
  15. @EnableSwagger2//支持swagger2
  16. public class SwaggerConfig {
  17. /**
  18. * 创建BeanApi
  19. * apiInfo() 增加API相关信息
  20. * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
  21. * 本例采用指定扫描的包路径来定义指定要建立API的目录。
  22. *
  23. * @return
  24. */
  25. @Bean
  26. public Docket createRestApi() {
  27. return new Docket(DocumentationType.SWAGGER_2)
  28. .apiInfo(apiInfo())
  29. .select()
  30. .apis(RequestHandlerSelectors.basePackage("com.tpdog"))//扫描Api包
  31. .paths(PathSelectors.any())
  32. .build();
  33. }
  34. /**
  35. * 创建该API的基本信息(这些基本信息会展现在文档页面中)
  36. * 访问地址:http://项目实际地址/swagger-ui.html
  37. * @return
  38. */
  39. private ApiInfo apiInfo() {
  40. return new ApiInfoBuilder()
  41. .title("Springboot-Swagger示例")//api的标日
  42. .description("一般常用api信息")//api描述
  43. .termsOfServiceUrl("https://www.baidu.com/")//服务地址
  44. .contact(new Contact("cqc", "https://www.baidu.com/", "leomple@163.com"))//联系信息
  45. .version("1.0")
  46. .build();
  47. }
  48. }

3. 编写API类

  1. package com.tpdog.controller;
  2. import javax.servlet.http.HttpServletRequest;
  3. import org.springframework.http.HttpStatus;
  4. import org.springframework.http.ResponseEntity;
  5. import org.springframework.stereotype.Controller;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestMethod;
  8. import org.springframework.web.bind.annotation.ResponseBody;
  9. import io.swagger.annotations.Api;
  10. import io.swagger.annotations.ApiImplicitParam;
  11. import io.swagger.annotations.ApiOperation;
  12. @Controller
  13. @RequestMapping("/dateapi")
  14. @Api(value = "日期管理API")
  15. public class DateController {
  16. @RequestMapping(value = "/date", method = RequestMethod.GET)
  17. @ResponseBody
  18. @ApiImplicitParam(paramType = "query",name= "cityid" ,value = "城市id",dataType = "string")
  19. @ApiOperation(value = "通过城市id获取天气信息", notes="返回城市天气信息")
  20. public ResponseEntity<Object> getDateInfo(HttpServletRequest request) {
  21. return new ResponseEntity<>(HolidayApi.getHoliday("s"), HttpStatus.OK);
  22. }
  23. }

4. 启动Springboot启动类,在浏览器中输入:http://localhost:8099/swagger-ui.html

记住两处的端口要对应,默认的是8080,如需修改端口则在src/main/resources下建立application.properties文件并加入server.port=8099    然后保存,8099随意加的可以加入自己喜欢的四位端口号,值尽量大一些,推荐使用8080以后的重新启动Springboot启动类在浏览器中输入:http://localhost:8099/swagger-ui.html访问

一般常见问题,下面问题要修改端口号,参照4当中的操作,修改端口号。访问api地址不显示controller,是由于在SwaggerConfig类中没有加入@ComponentScan("你的controller包路径"),扫描api包的路径即可显示 

 

种一棵树最好的时间是十年前,其次是现在。 

 

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/知新_RL/article/detail/856987
推荐阅读
相关标签
  

闽ICP备14008679号