Swagger_常用注解

1.常用注解

@Api(value = "测试Controller",tags = {"测试接口"})
@RestController     //  组合注解@ResponseBody,@Controller
public class HelloController {
    @ApiOperation("hello请求")
    @GetMapping("hello")
    public String hello(){
        return "hello";
    }
}

2.页面展示

3.类上注解的使用

（1）bean类中

package com.linxin.swagger.bean;

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

/**
 * @author zhangxinlin
 * @date 2021/5/8-14:43
 */
@ApiModel("用户信息")
public class User  {
    @ApiModelProperty("用户Id")
    private Long id;
    @ApiModelProperty("用户姓名")
    private String userName;
    @ApiModelProperty("用户密码")
    private String password;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

(2)控制层使用 

package com.linxin.swagger.controller;

import com.linxin.swagger.bean.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.websocket.server.PathParam;

/**
 * @author zhangxinlin
 * @date 2021/5/8-14:45
 */
@RestController
@Api(value = "用户操作",tags = "用户接口")
public class UserController {
    @ApiOperation("获取用户")
    @GetMapping("/getUser/{Id}")
    public User GetUser(@ApiParam("用户ID") @PathParam("id") Long id){
        User user = new User();
        user.setId(1L);
        user.setUserName("张三");
        user.setPassword("123456");
        return user;
    }
}

（3）页面效果展示