SpringBoot集成Swagger2笔记

集成操作步骤

1. 添加依赖
   pom.xml

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

2. 启动类添加注解：@EnableSwagger2Doc
3. application.properties

   swagger.enabled=是否启用swagger，默认：true
   swagger.title=标题
   swagger.description=描述
   swagger.version=版本
   swagger.license=许可证
   swagger.licenseUrl=许可证URL
   swagger.termsOfServiceUrl=服务条款URL
   swagger.contact.name=维护人
   swagger.contact.url=维护人URL
   swagger.contact.email=维护人email
   swagger.base-package=swagger扫描的基础包，默认：全扫描
   swagger.base-path=需要处理的基础URL规则，默认：/**
   swagger.exclude-path=需要排除的URL规则，默认：空
   swagger.host=文档的host信息，默认：空
   swagger.globalOperationParameters[0].name=参数名
   swagger.globalOperationParameters[0].description=描述信息
   swagger.globalOperationParameters[0].modelRef=指定参数类型
   swagger.globalOperationParameters[0].parameterType=指定参数存放位置,可选header,query,path,body.form
   swagger.globalOperationParameters[0].required=指定参数是否必传，true,false
   

4. 启动应用，访问：http://localhost:8080/swagger-ui.html

文档描述注解

• @Api()用于类： 表示标识这个类是swagger的资源
• @ApiOperation()用于方法： 表示一个http请求的操作
• @ApiParam()用于方法，参数，字段说明： 表示对参数的添加元数据（说明或是否必填等）
• @ApiModel()用于类： 表示对类进行说明，用于参数用实体类接收
• @ApiModelProperty()用于方法，字段： 表示对model属性的说明或者数据操作更改
• @ApiIgnore()用于类，方法，方法参数： 表示这个方法或者类被忽略
• @ApiImplicitParam() 用于方法： 表示单独的请求参数