springboot集成swagger3与knife4j的详细代码
springboot集成swagger3
swagger3的springboot启动器jar包
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency>
注意:当前SpringBoot版本为2.5.6,Swagger3.0目前无法完全兼容SpringBoot2.6.x!
编写TestController代码
@RestController @RequestMapping("test") public class TestController { @GetMapping public Map<String, Object> get(@RequestParam String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } @PostMapping public Map<String, Object> post() { Map<String, Object> r = new HashMap<>(1); r.put("code", 200); return r; } @PutMapping public Map<String, Object> put(String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } @DeleteMapping public Map<String, Object> delete(String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } }
创建Swagger3Configuration
@Configuration @EnableOpenApi public class SwaggerConfig { private static final String VERSION = "0.0.1"; @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .groupName("分组名称") .apiInfo(apiInfo()) .select() //要扫描的包 .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() // 设置标题 .title("文档标题") //联系人 .contact(contact()) //描述 .description("xxx文档") //服务 .termsOfServiceUrl("https://spring.io/") //许可证 .license("Apache 2.0") .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0") .version(VERSION) .build(); } private Contact contact (){ return new Contact("SpringBoot", "https://spring.io/", "email"); } }
运行演示
访问网址:http://127.0.0.1:8081/swagger-ui/index.html
对接口进行注解
swagger中常用的注解
注解 | 作用 | 使用位置 |
---|---|---|
@Api | 表示对类的说明常用参数 | 类 |
@ApiOperation | 说明方法的用途 | 方法 |
@ApiImplicitParams | 里面可以包含多个@ApiImplicitParam | 方法 |
@ApiImplicitParam | 描述参数的用途 | 方法 |
@ApiModel | 表示一个数据类的信息 | 类 |
@ApiModelProperty | 描述数据类的属性 | 属性 |
@ApiIgnore | 忽略某个字段使之不显示在文档中 | 属性 |
接口基本使用
1.新建一个用户实体类
@ApiModel("用户") @Data public class User { @ApiModelProperty("用户名") private String username; @ApiModelProperty("密码") private String password; }
2.给TestController添加注解
@Api(tags = "测试接口") @RestController @RequestMapping("test") public class TestController { @ApiOperation("get请求") @GetMapping @ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class) public Map<String, Object> get(@RequestParam String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } @ApiOperation("post请求") @PostMapping public Map<String, Object> post(@RequestBody User user) { Map<String, Object> r = new HashMap<>(1); r.put("code", 200); return r; } @ApiOperation("put请求") @PutMapping @ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class) public Map<String, Object> put(String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } @ApiOperation("delete请求") @DeleteMapping @ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class) public Map<String, Object> delete(String id) { Map<String, Object> r = new HashMap<>(1); r.put("id", id); return r; } }
运行结果
集成更好的UI-knife4j
maven
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-micro-spring-boot-starter</artifactId> <version>3.0.3</version> </dependency>
启动器
在SwaggerConfig类上添加**@EnableKnife4j**
@Configuration @EnableOpenApi @EnableKnife4j public class SwaggerConfig
访问网站:http://127.0.0.1:8080/doc.html#/home
到此这篇关于springboot集成swagger3与knife4j的文章就介绍到这了,更多相关springboot集成swagger3内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
相关文章
Apache Commons BeanUtils: JavaBean操作方法
这篇文章主要介绍了Apache Commons BeanUtils: JavaBean操作的艺术,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2023-12-12解决java try throw exception finally遇上return break conti
这篇文章主要介绍了解决java try throw exception finally遇上return break continue造成异常丢失问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-11-11java中BCryptPasswordEncoder密码的加密与验证方式
这篇文章主要介绍了java中BCryptPasswordEncoder密码的加密与验证方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-08-08详解java8在Collection中新增加的方法removeIf
这篇文章主要介绍了详解java8在Collection中新增加的方法removeIf的相关资料,需要的朋友可以参考下2018-01-01
最新评论