<!--        添加swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2 // 开启Swagger功能
@Configuration //添加该类为配置类
public class SwaggerConfig {
    
}

    /**
     * 为每个开发者提供一个接口
     */
    @Bean
    Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("小码同学")
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                // 扫描知道的包接口
                .apis(RequestHandlerSelectors.basePackage("site.hikki.controller"))
                // 表示扫描整个项目的接口
//                .apis(RequestHandlerSelectors.any())
                // 不扫描接口
//                .apis(RequestHandlerSelectors.none())
                .build();
    }

    /**
     * 为每个开发者提供一个接口
     * @return
     */
    @Bean
    Docket docketB(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("开发者B")
                .apiInfo(apiInfo())
                .select()
                .build();
    }

    /**
     * 接口信息
     */
    private ApiInfo apiInfo() {
        // 作者信息
        Contact contact = new Contact("小码同学", "https://blog.hikki.site", "aa1341151056@163.com");
        return new ApiInfoBuilder()
                //文档标题
                .title("小码博客接口测试")
                //文档描述
                .description("喜欢的东西就努力去追求，万一成功了呢！")
                // 版本
                .version("1.0")
                // 团队网站
                .termsOfServiceUrl("https://blog.hikki.site")
                // 作者信息
                .contact(contact) 
                .build();
    }

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

@ApiModel("用户实体类") // API文档注释
public class User {
    @ApiModelProperty("用户名") // 参数注释
    private String username;
    @ApiModelProperty("密码")  //参数注释
    private String password;

    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;
    }
    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }
}

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.*;
import site.hikki.pojo.User;

import java.util.ArrayList;
import java.util.List;

@Api(description = "User控制层")
@RestController
@RequestMapping
public class UserController {


    @ApiOperation("根据ID查询用户")
    @GetMapping("/user{id}")
    public String getUser(@ApiParam("用户ID") Integer id){
        return "get userid = "+id;
    }

    @ApiOperation("查询全部用户")
    @GetMapping("user")
    public List<User> getAll(){
        User user = new User("小码同学", "123456");
        User user1 = new User("吴小白", "123456");
        ArrayList<User> list = new ArrayList<>();
        list.add(user);
        list.add(user1);
        return list;
    }

    @ApiOperation("登录")
    @PostMapping("user")
    public String login(User user){
        return "login su";
    }

    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "用户名", required = true, paramType = "form"),
            @ApiImplicitParam(name = "password", value = "密码", required = true, paramType = "form"),
            @ApiImplicitParam(name = "mobile", value = "手机号", required = true, paramType = "form")
    })
    @PostMapping("register")
    public String register(String username,String password,String mobile){
        return "ok";
    }

    @ApiOperation("根据ID删除用户")
    @DeleteMapping("/user{id}")
    public String delUser(@ApiParam("用户ID") Integer id){
        return "del user="+id;
    }

    @ApiOperation("测试错误接口")
    @GetMapping("/geterror")
    public  String error(){
        int i = 5 / 0;
        return "测试返回错误";
    }
}

@Controller
@RequestMapping(value = "/api/pet", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Api(value = "/pet", description = "Operations about pets")
public class PetController {

}

@RequestMapping(value = "/order/{orderId}", method = GET)
  @ApiOperation(
      value = "Find purchase order by ID",
      notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
      response = Order.class,
      tags = { "Pet Store" })
   public ResponseEntity<Order> getOrderById(@PathVariable("orderId") String orderId)
      throws NotFoundException {
    Order order = storeData.get(Long.valueOf(orderId));
    if (null != order) {
      return ok(order);
    } else {
      throw new NotFoundException(404, "Order not found");
    }
  }

public ResponseEntity<Order> getOrderById(
      @ApiParam(value = "ID of pet that needs to be fetched", allowableValues = "range[1,5]", required = true)
      @PathVariable("orderId") String orderId)

@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")
	})
	@PostMapping("/login")
	public JsonResult login(@RequestParam String mobile, @RequestParam String password,
	@RequestParam Integer age){
		//...
	    return JsonResult.ok(map);
	}

@ApiResponses({
		@ApiResponse(code = 200, message = "请求成功"),
		@ApiResponse(code = 400, message = "请求参数没填好"),
		@ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")
	}) 
	@ResponseBody
	@RequestMapping("/list")
	public JsonResult list(@RequestParam String userId) {
		...
		return JsonResult.ok().put("page", pageUtil);
	}

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

	@ApiModelProperty(value = "是否成功",required=true)
	private boolean success=true;	
	
	@ApiModelProperty(value = "错误码")
	private Integer errCode;
	
	@ApiModelProperty(value = "提示信息")
	private String message;
	
    @ApiModelProperty(value = "数据")
	private Object data;
		
	/* getter/setter 略*/
}

    @GetMapping("/query/{id}")
    private List<Student> queryById( @ApiParam(name = "id", value = "学生id", required = true) @PathVariable("id") Long id) {
        List<Student> studentList = studentService.queryById(id);
        return studentList;
    }

    @GetMapping("/query/student")
    private List<Student> queryByIdStu(@ApiParam(name = "byId", value = "学生id", required = false) @RequestParam("id") Long id) {
        List<Student> studentList = studentService.queryById(id);
        return studentList;
    }

@ApiIgnore
@Api(description = "User控制层")
@RestController
@RequestMapping
public class UserController {
    // ...接口方法
}

@ApiIgnore
@ApiOperation("根据ID查询用户")
@GetMapping("/user{id}")
public String getUser(@ApiParam("用户ID") Integer id) {
    return "get userid = " + id;
}

@ApiOperation(value = "根据ID查询用户",hidden = true)
@GetMapping("/user{id}")
public String getUser(@ApiParam("用户ID") Integer id) {
    return "get userid = " + id;
}