# springbootswagger

**Repository Path**: yhditto/springbootswagger

## Basic Information

- **Project Name**: springbootswagger
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-07-05
- **Last Updated**: 2022-08-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

springboot + swagger
各注解说明：

    @Api：用在类上，说明该类的作用
    @ApiOperation：用在方法上，说明方法的作用
    @ApiImplicitParams：用在方法上包含一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        paramType：参数放在哪个地方
            header-->请求参数的获取：@RequestHeader
            query-->请求参数的获取：@RequestParam
            path（用于restful接口）-->请求参数的获取：@PathVariable
            body（不常用）
            form（不常用）
        name：参数名
        dataType：参数类型
        required：参数是否必须传
        value：参数的意思
        defaultValue：参数的默认值
    @ApiResponses：用于表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类
    @ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
        @ApiModelProperty：描述一个model的属性
注意事项：
⑴.api参数的说明设置

  @ApiImplicitParams(@ApiImplicitParam(paramType = "query",name ="id" ,value = "用户ID",required = true,dataType ="Long",defaultValue="1"))   
    
    1.在使用@PathVariable注解是必须要在@ApiImplicitParams注解里设置paramType="path"否则无法注入。
    实质上是把@RequestMapping(value="/{id}", method=RequestMethod.PUT).把{id}整个值替换成页面传进去的值。eg:http://localhost:8080/users/id。
    
    2.在方法上使用@RequestParam(param)注解.在swagger首页输入参数id，
    @RequestMapping(value="/getuser", method=RequestMethod.GET)
     public User getUser(@RequestParam("id") Long id)
    则请求url:http://localhost:8080/users/getuser?id=12.则需要设置paramType = "query"。
    不然默认以json格式会报错。
    如果ApiImplicitParam中的paramType是query的话，是无法注入到rest路径中的，而且如果是path的话，
    是不需要配置ApiImplicitParam的，即使配置了，其中的value=""也不会在swagger-ui展示出来。
    3.@ModelAttribute注解：
    绑定请求参数到指定对象 。如果方法上有这个注解会把对象的属性以参数的形式
    整个暴露在页面上。