Swagger使用

本文详细介绍了如何在项目中使用Swagger2,从引入Maven依赖开始,接着配置application.yml文件,然后编写Swagger2的配置类SwaggerConfig。接着,文章讲解了Swagger的各种注解,如@Api用于标识资源类,@ApiOperation描述HTTP请求,@ApiParam用于参数说明,@ApiModel和@ApiModelProperty用于类和属性的说明,最后,@ApiIgnore用于忽略某些元素。通过这些步骤,读者可以了解如何创建和访问Swagger文档页面。

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

1.引入maven依赖到pom文件中

<!--swagger2完成包 service类工程需要生成api页面-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!--ui http://svrip:svr端口/swagger-ui.html-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<!--增强ui http://svrip:svr端口/doc.html-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

2.配置application.yml文件

# Swagger配置
swagger:
  # 是否开启swagger
  enabled: true
  # 请求前缀
  pathMapping:

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值