经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring Boot » 查看文章
springboot集成swagger3与knife4j的详细代码
来源:jb51  时间:2022/8/16 17:27:32  对本文有异议

springboot集成swagger3

swagger3的springboot启动器jar包

  1. <!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
  2. <dependency>
  3. <groupId>io.springfox</groupId>
  4. <artifactId>springfox-boot-starter</artifactId>
  5. <version>3.0.0</version>
  6. </dependency>

注意:当前SpringBoot版本为2.5.6,Swagger3.0目前无法完全兼容SpringBoot2.6.x!

编写TestController代码

  1. @RestController
  2. @RequestMapping("test")
  3. public class TestController {
  4. @GetMapping
  5. public Map<String, Object> get(@RequestParam String id) {
  6. Map<String, Object> r = new HashMap<>(1);
  7. r.put("id", id);
  8. return r;
  9. }
  10.  
  11. @PostMapping
  12. public Map<String, Object> post() {
  13. Map<String, Object> r = new HashMap<>(1);
  14. r.put("code", 200);
  15. return r;
  16. }
  17. @PutMapping
  18. public Map<String, Object> put(String id) {
  19. Map<String, Object> r = new HashMap<>(1);
  20. r.put("id", id);
  21. return r;
  22. }
  23.  
  24. @DeleteMapping
  25. public Map<String, Object> delete(String id) {
  26. Map<String, Object> r = new HashMap<>(1);
  27. r.put("id", id);
  28. return r;
  29. }
  30. }

创建Swagger3Configuration

  1. @Configuration
  2. @EnableOpenApi
  3. public class SwaggerConfig {
  4. private static final String VERSION = "0.0.1";
  5. @Bean
  6. public Docket createRestApi() {
  7. return new Docket(DocumentationType.OAS_30)
  8. .groupName("分组名称")
  9. .apiInfo(apiInfo())
  10. .select()
  11. //要扫描的包
  12. .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
  13. .paths(PathSelectors.any())
  14. .build();
  15. }
  16. private ApiInfo apiInfo() {
  17. return new ApiInfoBuilder()
  18. // 设置标题
  19. .title("文档标题")
  20. //联系人
  21. .contact(contact())
  22. //描述
  23. .description("xxx文档")
  24. //服务
  25. .termsOfServiceUrl("https://spring.io/")
  26. //许可证
  27. .license("Apache 2.0")
  28. .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
  29. .version(VERSION)
  30. .build();
  31. }
  32. private Contact contact (){
  33. return new Contact("SpringBoot", "https://spring.io/", "email");
  34. }
  35. }

运行演示

访问网址:http://127.0.0.1:8081/swagger-ui/index.html

对接口进行注解

swagger中常用的注解

注解作用使用位置
@Api表示对类的说明常用参数
@ApiOperation说明方法的用途方法
@ApiImplicitParams里面可以包含多个@ApiImplicitParam方法
@ApiImplicitParam描述参数的用途方法
@ApiModel表示一个数据类的信息
@ApiModelProperty描述数据类的属性属性
@ApiIgnore忽略某个字段使之不显示在文档中属性

接口基本使用

1.新建一个用户实体类

  1. @ApiModel("用户")
  2. @Data
  3. public class User {
  4. @ApiModelProperty("用户名")
  5. private String username;
  6. @ApiModelProperty("密码")
  7. private String password;
  8. }

2.给TestController添加注解

  1. @Api(tags = "测试接口")
  2. @RestController
  3. @RequestMapping("test")
  4. public class TestController {
  5. @ApiOperation("get请求")
  6. @GetMapping
  7. @ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class)
  8. public Map<String, Object> get(@RequestParam String id) {
  9. Map<String, Object> r = new HashMap<>(1);
  10. r.put("id", id);
  11. return r;
  12. }
  13.  
  14. @ApiOperation("post请求")
  15. @PostMapping
  16. public Map<String, Object> post(@RequestBody User user) {
  17. Map<String, Object> r = new HashMap<>(1);
  18. r.put("code", 200);
  19. return r;
  20. }
  21.  
  22. @ApiOperation("put请求")
  23. @PutMapping
  24. @ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class)
  25. public Map<String, Object> put(String id) {
  26. Map<String, Object> r = new HashMap<>(1);
  27. r.put("id", id);
  28. return r;
  29. }
  30.  
  31. @ApiOperation("delete请求")
  32. @DeleteMapping
  33. @ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class)
  34. public Map<String, Object> delete(String id) {
  35. Map<String, Object> r = new HashMap<>(1);
  36. r.put("id", id);
  37. return r;
  38. }
  39. }

运行结果

在这里插入图片描述

 

在这里插入图片描述

在这里插入图片描述

集成更好的UI-knife4j

maven

  1. <dependency>
  2. <groupId>com.github.xiaoymin</groupId>
  3. <artifactId>knife4j-micro-spring-boot-starter</artifactId>
  4. <version>3.0.3</version>
  5. </dependency>

启动器

在SwaggerConfig类上添加**@EnableKnife4j**

  1. @Configuration
  2. @EnableOpenApi
  3. @EnableKnife4j
  4. public class SwaggerConfig

访问网站:http://127.0.0.1:8080/doc.html#/home

到此这篇关于springboot集成swagger3与knife4j的文章就介绍到这了,更多相关springboot集成swagger3内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue!

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号