【Spring Boot实战与进阶】整合Swagger3生成接口文档(1)

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“Restful API接口”)

.description(“Swagger3接口文档”)

.version(“1.0”)

.build();

}

}

说明:

  • @EnableOpenApi:开启swagger功能(@EnableSwagger2在3.0被移除)

三、Controller测试类


@Api(“TestController”)

@RestController

public class TestController {

@ApiOperation(value = “添加用户”, notes = “添加用户”)

@PostMapping(“/addUser”)

public void addUser() {

}

@ApiOperation(value = “获取用户信息”, notes = “获取用户信息”)

@GetMapping(“/getUser”)

public void getUser() {

}

}

四、启动项目


访问地址:http://localhost:8080/swagger-ui/index.html

在这里插入图片描述

五、拓展知识


1、如何配置线上时关闭swagger?

是否开启swagger,线上环境一般是需要关闭的

springfox:

documentation:

auto-startup: false

2、常用的配置注解

| Annotation | Attribute | Target Property | Description |

| :-- | :-- | :-- | :-- |

| ApiModelProperty | value | ModelProperty#description | @ApiModelProperty(value=“${property1.description}”) |

| ApiModelProperty | description | ModelProperty#description | @ApiModelProperty(notes=“${property1.description}”) |

| ApiParam | value | Parameter#description | @ApiParam(value=“${param1.description}” |

| ApiImplicitParam | value | Parameter#description | @ApiImplicitParam(value=“KaTeX parse error: Expected 'EOF', got '#' at position 60: …tes | Operation#̲notes | @ApiOpe…{operation1.description}”) |
| ApiOperation | summary | Operation#summary | @ApiOperation(value=“KaTeX parse error: Expected 'EOF', got '#' at position 67: …lue | Parameter#̲defaultValue | …{param1.defaultValue}”) |
| RequestHeader | defaultValue | Parameter#defaultValue | @RequestHeader(defaultValue=“${param1.defaultValue}”) |

总结:绘上一张Kakfa架构思维大纲脑图(xmind)

image

其实关于Kafka,能问的问题实在是太多了,扒了几天,最终筛选出44问:基础篇17问、进阶篇15问、高级篇12问,个个直戳痛点,不知道如果你不着急看答案,又能答出几个呢?

若是对Kafka的知识还回忆不起来,不妨先看我手绘的知识总结脑图(xmind不能上传,文章里用的是图片版)进行整体架构的梳理

梳理了知识,刷完了面试,如若你还想进一步的深入学习解读kafka以及源码,那么接下来的这份《手写“kafka”》将会是个不错的选择。

  • Kafka入门

  • 为什么选择Kafka

  • Kafka的安装、管理和配置

  • Kafka的集群

  • 第一个Kafka程序

  • Kafka的生产者

  • Kafka的消费者

  • 深入理解Kafka

  • 可靠的数据传递

  • Spring和Kafka的整合

  • SpringBoot和Kafka的整合

  • Kafka实战之削峰填谷

  • 数据管道和流式处理(了解即可)

image

image

pring和Kafka的整合

  • SpringBoot和Kafka的整合

  • Kafka实战之削峰填谷

  • 数据管道和流式处理(了解即可)

[外链图片转存中…(img-zOoVWm54-1714520231448)]

[外链图片转存中…(img-lccGFk2d-1714520231448)]

本文已被CODING开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

  • 28
    点赞
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一种API文档生成工具,可以帮助开发人员自动生成API文档Swagger3是Swagger的最新版本,它提供了更多的功能和更好的用户体验。下面是使用Swagger3生成接口文档的步骤: 1.在pom.xml文件中添加Swagger3的依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2.添加Swagger配置类: ```java @Configuration @EnableSwagger2WebMvc public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API文档") .description("这是一个API文档示例") .version("1.0.0") .build(); } } ``` 3.在Controller中添加Swagger接口注解: ```java @RestController @RequestMapping("/api") @Api(tags = "用户管理") public class UserController { @GetMapping("/users") @ApiOperation("获取用户列表") public List<User> getUsers() { // ... } @PostMapping("/users") @ApiOperation("创建用户") public void createUser(@RequestBody User user) { // ... } @GetMapping("/users/{id}") @ApiOperation("获取用户信息") public User getUserById(@PathVariable Long id) { // ... } @PutMapping("/users/{id}") @ApiOperation("更新用户信息") public void updateUser(@PathVariable Long id, @RequestBody User user) { // ... } @DeleteMapping("/users/{id}") @ApiOperation("删除用户") public void deleteUser(@PathVariable Long id) { // ... } } ``` 4.启动应用程序并访问http://localhost:8080/swagger-ui/index.html,即可查看和测试接口

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值