05-Swagger

1、引入依赖

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.9.1.RELEASE</version>
</dependency>

2、配置

swagger:
  base-package: com.dong
  exclude-path: /error,/actuator/**,/global/**
  contact:
    name: qixiaodong
    email: 120651720@qq.com
  title: ${spring.application.name}
  ui-config:
    json-editor: true
  globalOperationParameters:
    - name: JSESSIONID
      modelRef: string
      parameterType: header
      required: false

API详细说明

作用范围	API	使用位置
对象属性	@ApiModelProperty	用在出入参数对象的字段上
协议集描述	@Api	用于controller类上
协议描述	@ApiOperation	用在controller的方法上
Response集	@ApiResponses	用在controller的方法上
Response	@ApiResponse	用在 @ApiResponses里边
非对象参数集	@ApiImplicitParams	用在controller的方法上
非对象参数描述	@ApiImplicitParam	用在@ApiImplicitParams的方法里边
描述返回对象的意义	@ApiModel	用在返回对象类上

注解

@ApiImplicitParam

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