整合swagger2

最新推荐文章于 2023-07-12 20:00:00 发布

jwolf2

最新推荐文章于 2023-07-12 20:00:00 发布

阅读量126

点赞数

分类专栏： other

本文链接：https://blog.csdn.net/qq_39506978/article/details/88866897

版权

other 专栏收录该内容

35 篇文章 0 订阅

订阅专栏

1.导入依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

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

2.入口类开启@EnableSwagger2

3.访问：http://localhost:8888/swagger-ui.html，即可在看到所有URL并在线测试接口

4.其它设置：需要在controller方法或类上使用注解帮助文档生成。参考：https://www.cnblogs.com/jtlgb/p/8532433.html

@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数

jwolf2

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
整合swagger2

1.导入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</ver...
复制链接

扫一扫

专栏目录