@Api：放在 請(qǐng)求的類上，與 @Controller 并列，說明類的作用，如用戶模塊，訂單類等。
tags="說明該類的作用"
value="描述該類作用" [推薦用這個(gè)]

@Api 其它屬性配置：

屬性名稱 備注
value url的路徑值
tags 如果設(shè)置這個(gè)值、value的值會(huì)被覆蓋
description 對(duì)api資源的描述
basePath 基本路徑
position 如果配置多個(gè)Api 想改變顯示的順序位置
produces 如, “application/json, application/xml”
consumes 如, “application/json, application/xml”
protocols 協(xié)議類型，如: http, https, ws, wss.
authorizations 高級(jí)特性認(rèn)證時(shí)配置
hidden 配置為true ，將在文檔中隱藏

@ApiOperation："用在請(qǐng)求的方法上，說明方法的作用"
	  value="說明方法的作用"
	  notes="方法的備注說明"

@Api(tags="用戶模塊")
@Controller
public class UserController {

	@ApiOperation(value="用戶登錄",notes="隨邊說點(diǎn)啥")
	@ApiImplicitParams({
		@ApiImplicitParam(name="mobile",value="手機(jī)號(hào)",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：方法返回對(duì)象的說明
	@ApiResponse：每個(gè)參數(shù)的說明
	    code：數(shù)字，例如400
	    message：信息，例如"請(qǐng)求參數(shù)沒填好"
	    response：拋出異常的類

@ApiModel：用于JavaBean的類上面，表示此 JavaBean 整體的信息
			（這種一般用在post創(chuàng)建的時(shí)候，使用 @RequestBody 這樣的場(chǎng)景，
			請(qǐng)求參數(shù)無法使用 @ApiImplicitParam 注解進(jìn)行描述的時(shí)候 ）

@ApiModel(description= "返回響應(yīng)數(shù)據(jù)")
public class RestMessage implements Serializable{

	@ApiModelProperty(value = "是否成功")
	private boolean success=true;
	@ApiModelProperty(value = "返回對(duì)象")
	private Object data;
	@ApiModelProperty(value = "錯(cuò)誤編號(hào)")
	private Integer errCode;
	@ApiModelProperty(value = "錯(cuò)誤信息")
	private String message;
		
	/* getter/setter 略*/
}

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.2.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.2.2</version>
</dependency>

package com.zhiyou100.configBeans;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Author ZhengZiXuan
 * @Desc
 */
@Configuration // @Configuration注解，讓Spring來加載該類配置。
@EnableSwagger2 //@EnableSwagger2注解來啟用Swagger2
public class SwaggerConfigBean {
    /**
     * 創(chuàng)建API應(yīng)用
     * apiInfo() 增加API相關(guān)信息
     * 通過select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)，
     * 本例采用指定掃描的包路徑來定義指定要建立API的目錄。
     *
     * @return
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zhiyou100.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 創(chuàng)建該API的基本信息（這些基本信息會(huì)展現(xiàn)在文檔頁面中）
     * 訪問地址：http://項(xiàng)目實(shí)際地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用Swagger2 構(gòu)建RESTful APIS - 廢物")
                .description("廢物 - Swagger使用演示")
                .termsOfServiceUrl("www.zzxBIuBIuBIu.com")
                .version("1.0")
                .build();
    }

}

package com.zhiyou100.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @Author ZhengZiXuan
 * @Desc
 */
@Controller
@Api("測(cè)試Swagger 的Controller類")
public class TestController {
    @ApiOperation(value="根據(jù)id查詢名字",notes = "備注:無")
    @ApiImplicitParam(name = "id",value = "用戶id",required = true,
            paramType = "query",dataType = "Integer")
    @RequestMapping("/getNameById")
    @ResponseBody
    public String getNameById(int id){
        return "張三";
    }
}

package com.zhiyou100.model;

/**
 * @Author ZhengZiXuan
 * @Date 2021/05/10
 * @Desc
 */

public class User {

    private int id;
    private String name;
    private String password;

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", password='" + password + '\'' +
                '}';
    }

    public User() {
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPassword() {
        return password;
    }

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

    public User(int id, String name, String password) {
        this.id = id;
        this.name = name;
        this.password = password;
    }
}

package com.zhiyou100.controller;

import com.zhiyou100.model.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

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

/**
 * @Author ZhengZiXuan
 * @Date 2021/05/10
 * @Desc  
有點(diǎn)BUG  就是list集合中的增刪改
 */
@RestController
@Api("User類的增刪改查API")
public class UserController {
    ArrayList<User> users = null;
    public UserController(){
        users = new ArrayList<>();
        users.add(new User(1,"張三","123"));
        users.add(new User(2,"李四","1234"));
        users.add(new User(3,"王五","12345"));
        System.out.println("init users "+users);
    }
    /**
     * 根據(jù)id查User
     */
    @ApiOperation("根據(jù)id查用戶")
    @ApiImplicitParam(name = "id",value = "用戶id",
                      required = true,paramType = "path",
                        dataType = "Integer")
    @RequestMapping(value="/user/get/{id}",method = RequestMethod.GET)
    public User getUserById(@PathVariable("id") Integer id){
        System.out.println("getUserById id: "+id);
        if (id != null){
            if (id>0 && id <4){
                User user = users.get(id);
                System.out.println("getUserById User: "+user);
                return user;
            }
        }
        return null;
    }
    /**
     * 查全部user
     */
    @ApiOperation("查詢?nèi)坑脩?)
    @RequestMapping(value="/user/get",method = RequestMethod.GET)
    public List<User> getAllUser(){
        System.out.println("getAllUser");
        return users;
    }

    /**
     * 添加User
     */
    @ApiOperation("添加用戶")
    @ApiImplicitParam(name="user",value = "用戶對(duì)象",paramType = "body",dataType = "User")
    @RequestMapping(value="/user/add",method = RequestMethod.POST)
    public User addUser(@RequestBody User user){
        System.out.println("addUser User:"+user);
        if (user == null || user.getId() == 0){
            return null;
        }
        users.add(user);
        return user;
    }

    /**
     * 刪除User
     */
    @ApiOperation("根據(jù)id刪除用戶")
    @ApiImplicitParam(name = "id",value = "用戶id",
            required = true,paramType = "path",
            dataType = "Integer")
    @RequestMapping(value="/user/delete/{id}",method = RequestMethod.DELETE)
    public boolean delUserById(@PathVariable("id") Integer id){
        System.out.println("delUserById id:"+id);
        if (id != null){
            users.remove(id);
            return true;
        }
        return false;
    }

    /**
     * 更新User
     */
    @ApiOperation("根據(jù)id更新用戶")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",value = "用戶id",
                    required = true,paramType = "path",
                    dataType = "Integer"),
            @ApiImplicitParam(name = "user",value = "用戶對(duì)象",
                    required = true,paramType = "body",
                    dataType = "User")})
    @RequestMapping(value="/user/update/{id}",method = RequestMethod.PUT)
    public boolean UpdateUserById(@PathVariable("id") Integer id,@RequestBody User user){
        System.out.println("UpdateUserById id:"+id+"  ,   User:"+user);
        if (id != null && user != null){
            users.add(id,user);
            return true;
        }
        return false;
    }

}