springboot swagger的使用

本文详细介绍了如何在SpringBoot项目中集成Swagger,包括导入依赖、配置注解以及使用各种Swagger注解来描述API的方法和参数,使API文档自动生成。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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>
<!--swagger结束-->
2.在主类上声明

@SpringBootApplication
@EnableSwagger2
public class SpringbootApplication {

    public static void main(String[] args) {

        SpringApplication.run(SpringbootApplication.class, args);
    }

}

3.各种注解 
  http://localhost:8083/swagger-ui.html 访问

@ApiOperation(value = "用户查询服务") 写在方法上 说明这个方法是干嘛的
@ApiParam("用户id") 写在参数上 说明参数是干嘛的
@@ApiModelProperty("用户姓名") 写在实体类
  
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值