Spring Boot 集成 Swagger

本文介绍了如何在 Spring Boot 项目中集成 Swagger,通过添加相关依赖和配置,使用 Swagger 自动生成 RESTful 风格的 Web 服务文档。利用 Swagger 提供的注解如 @Api, @ApiOperation, @ApiParam 等,可以详细描述接口和参数,提高文档的可读性。" 119872819,569322,Scratch编程实践:寻找宝石迷宫挑战,"['Scratch', '编程实践', '蓝桥杯', '电子学会等级考试', '儿童编程']
摘要由CSDN通过智能技术生成

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在 Spring Boot 中可以通过集成 Swagger 的方式完成文档的自动生成并保持完整的一致性,集成步骤如下:

  1. 添加 Swagger 相关依赖
<!-- 用于扫描接口配置 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- 用于显示文档页面 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
  1. 启用 Swagger 文档配置
@Configuration
@EnableSwagger2
@WebContext
public class SwaggerConfig {

    @Bean
    public Docket petApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        
        // 配置文档基本描述信息
        docket.apiInfo(apiInfo());
        // 配置全局参数
        docket.globalOperationPar
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值