码迷,mamicode.com
首页 > 其他好文 > 详细

Swagger2

时间:2020-05-01 14:21:13      阅读:872      评论:0      收藏:0      [点我收藏+]

标签:param   通过   错误   请求方法   href   ble   swagger   忽略   引入   

  • 引入依赖
    • <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-common</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>

  • springboot整合
    • 添加@EnableSwagger2
  • 使用
    • Swagger 通过注解定制接口对外展示的信息,这些信息包括接口名、请求方法、参数、返回信息等。更多注解类型:

      • @Api:修饰整个类,描述Controller的作用
      • @ApiOperation:描述一个类的一个方法,或者说一个接口
      • @ApiParam:单个参数描述
      • @ApiModel:用对象来接收参数
      • @ApiProperty:用对象接收参数时,描述对象的一个字段
      • @ApiResponse:HTTP响应其中1个描述
      • @ApiResponses:HTTP响应整体描述
      • @ApiIgnore:使用该注解忽略这个API
      • @ApiError :发生错误返回的信息
      • @ApiImplicitParam:描述一个请求参数,可以配置参数的中文含义,还可以给参数设置默认值
      • @ApiImplicitParams:描述由多个 @ApiImplicitParam 注解的参数组成的请求参数列表
  • 访问http://localhost:9001/swagger-ui.html

Swagger2

标签:param   通过   错误   请求方法   href   ble   swagger   忽略   引入   

原文地址:https://www.cnblogs.com/shangyunlin/p/12813257.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!