Swagger

Author Avatar
ciky 08月 19,2024
  • 在其它设备中阅读本文章
  • 点击生成二维码
  • 访问地址 :
    IP:端口/content/swagger-ui.html

    image20240521211321247.png

  • 添加swagger依赖

     <!-- Spring Boot 集成 swagger -->
    <dependency>
        <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.9.0.RELEASE</version>
    </dependency>
    
  • 配置文件

    #配置swagger接口文档
    swagger:
      title: "学成在线内容管理系统"
      description: "内容系统管理系统对课程相关信息进行管理"
      base-package: com.xuecheng.content
      enabled: true
      version: 1.0.0
    
  • @Api注解,@ApiOperation注解

  • 常用注解

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

属性取值作用
paramType 查询参数类型
path以地址的形式提交数据
query直接跟参数完成自动映射赋值
body以流的形式提交 仅支持POST
header参数在request headers 里边提交
form以form表单的形式提交 仅支持POST
dataType 参数的数据类型 只作为标志说明,并没有实际验证
Long
String
name 接收参数名
value 接收参数的意义描述
required 参数是否必填
true必填
false非必填
defaultValue 默认值