swagger2的简单使用

这篇博客介绍了如何使用swagger2快速生成API文档,包括配置pom依赖、创建配置类,以及对Controller和方法的注解说明。通过@Api、@ApiOperation、@ApiImplicitParams和@ApiImplicitParam等注解,详细阐述了如何处理不同类型的参数,如单一参数和@RequestBody场景,并提供了实体类字段的处理方式。
摘要由CSDN通过智能技术生成

swagger2的简单使用

优点:
可以生成文档形式的API并提供给不同的团队使用

便于自己单测

无需过多冗余的word文档,这一点很重要,因为我在工作中就遇到这么一个情况,由于开发使用的文档和最新文档版本导致不一致,导致后期很烦人

=使用swagger流程=

1.引入pom依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

2.新建swagger2配置类

new class Swagger2

@Configuration //使用配置类注解
@EnableSwagger2 //启用这个配置类
public class Swagger2 {
	/**
	 * @Description:swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
	 */
	@
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值