SpringBoot使用Swagger2实现Restful API--使用说明

@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”
示例：
@Api(tags=“APP用户注册Controller”)

@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”
示例：
@ApiOperation(value=“用户注册”,notes=“手机号、密码都是必输项，年龄随边填，但必须是数字”)

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（不常用）—请求参数是@RequestBody
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer” （注意，对于int类型，使用dataType=“Long” ）
defaultValue：参数的默认值
示例：
@ApiImplicitParams({
@ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”),
@ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”),
@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)
})

@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiOperation(value = “select1请求”,notes = “多个参数，多种的查询参数类型”)
@ApiResponses({
@ApiResponse(code=400,message=“请求参数没填好”),
@ApiResponse(code=404,message=“请求路径没有或页面跳转路径不对”)
})

@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性
示例：

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{

    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;   
}

POST请求传入对象
示例：

   @ApiOperation(value="保存用户", notes="保存用户")
    @RequestMapping(value="/saveUser", method= RequestMethod.POST)
    public String saveUser(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){
        userDao.save(user);
        return "success!";
    }

以下是一个应用事例：

import com.wehotel.business.activity.common.RestResult;
import com.wehotel.business.activity.constant.RestStatusCode;
import com.wehotel.business.activity.vo.ActivityTypeVo;
import com.wehotel.business.activity.vo.FissionPosterHelpResponseVo;
import com.wehotel.business.activity.vo.PageVo;
import com.wehotel.business.activity.vo.request.ActivityTypeRequestVo;
import io.swagger.annotations.*;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;


@Slf4j
@RestController
@Api(tags = {"接口描述"})
@RequestMapping(path = "/api/test/")
public class TestController {


    @ApiOperation(value = "接口名称1", notes = "接口描述1")
    @ApiResponses({@ApiResponse(code = 200, message = "OK", response = ActivityTypeVo.class)})
    @ApiImplicitParam(name = "activityTypeRequestVo", value = "请求VO,传入json格式", required = true, paramType = "body", dataType = "ActivityTypeRequestVo")
    @PostMapping(path = "/types/list", produces = {"application/json"})
    public RestResult<PageVo<ActivityTypeVo>> typeslist(@RequestBody @Validated ActivityTypeRequestVo activityTypeRequestVo, BindingResult bindingResult) {
        RestResult restResult = new RestResult();
        try {
            if (bindingResult.hasErrors()) {
                return RestResult.fail(RestStatusCode.ARG_EX, bindingResult.getFieldError() == null ? "参数有误" : bindingResult.getFieldError().getDefaultMessage());
            }
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            restResult.setCode(RestStatusCode.BIZ_EX);
            restResult.setMsg("查询异常,请联系管理员");
        }
        return restResult;
    }

    @ApiOperation(value = "接口名称2", notes = "接口描述2")
    @ApiResponses({@ApiResponse(code = 200, message = "OK", response = FissionPosterHelpResponseVo.class)})
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "Id", required = true, paramType = "path", dataType = "Long"),
            @ApiImplicitParam(name = "wxAppId", value = "参与活动的公众号的微信appId", required = true, paramType = "query", dataType = "String"),
            @ApiImplicitParam(name = "wxOpenId", value = "参与活动的粉丝的微信openId", required = true, paramType = "query", dataType = "String")
    })
    @GetMapping(path = "/testdd/{id}/response", produces = {"application/json"})
    public RestResult<FissionPosterHelpResponseVo> fissionPosterHelp(@PathVariable(value = "id") int id, @RequestParam(value = "wxAppId") String wxAppId,
                                                                     @RequestParam(value = "wxOpenId") String wxOpenId) {
        RestResult restResult = new RestResult();
        try {
            return RestResult.success();
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            restResult.setCode(RestStatusCode.BIZ_EX);
            restResult.setMsg("完成情况异常,请联系管理员");
        }
        return restResult;
    }

}