Swagger是一個自動生成API文件的 框架，避免了傳統的手動編寫API文件，然後再發給前段的繁瑣。

首先：

1、新建一個Sping boot專案，引入以下依賴：

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

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

2、Swagger配置類：

@Configuration
@EnableSwagger2
public class Swgger2Configuration {

    @Bean
    public Docket createSwagger2Api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cn.spring.cloud.jennire.microservice"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("swagger測試")
                .description("簡單容易的API介面文件")
                .version("1.0")
                .build();
    }
}
 

配置類上需要 有@Configuration 和 @EnableSwagger2 註解  ，需要一個返回Docket的被@Bean註釋的 方法，名字隨意取。

此方法中，new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .....   ; apiInfo()方法，執行了Swagger的一些基本資訊，這些都是開發人員自己指定；

3、在Application上加EnableSwagger2註解  ，開啟Swagger：

@SpringBootApplication
@EnableSwagger2
public class MicroserviceApplication {

    public static void main(String[] args) {
        SpringApplication.run(MicroserviceApplication.class, args);
    }
}
 

4、在介面上加入Swagger：

@RestController
public class HelloController {

    @ApiOperation(value="測試API",notes = "API工具")
    @GetMapping("/hello")
    public String index(@RequestBody User user){

        return "hello";

    }
}

上面的介面有一個User 物件，User物件的引數也可以用Swagger來註釋：

@Getter
@Setter
@Builder
@ApiModel(description = "請求引數實體")
public class User implements Serializable {

    @ApiModelProperty(value = "使用者名稱稱",required = true)
    private String name;

    @ApiModelProperty(value = "使用者性別" ,required = true)
    private String sex;

    @ApiModelProperty(value = "使用者年齡",required = true)
    private int age;
}

@Getter 和@Setter 、 @Builder 註解  是實現了類中引數的 get set 方法，  Builder 是  實現了構建器的方式來 訪問和例項化是物件，只需要引入以下依賴：

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>

 接下來啟動專案，訪問localhost:8080/swagger-ui.html； 

Swagger中註解說明：

@Api()：作用於類上，表示這個類是swagger的資源。

    tags = ”說明該類的作用“

@ApiOperation()：用在請求的方法上，說明的方法的使用者和作用

    value=“說明方法的用途、作用”

    notes="方法的備註說明“

@ApiImplicitParams()：用在請求的方法上，表示一組引數說明，可以包含多個@ApiImplicitParam()

@ApiImplicitParam()：指定一個請求引數的各個方面

       name：引數名

       value：引數的漢字說明

       required：引數是否必須傳

       dataType：引數型別

       defaultValue：引數的預設值

@ApiResponses()：用在請求的方法上，表示一組響應。可以包含多個@ApiResponse()

@ApiResponse()：用於表示一個錯誤的響應資訊

    code：數字

    message：資訊

    response：丟擲異常的類      

@ApiModel()：用在響應類上，表示一個返回響應資料的資訊。

@ApiModelProperty()：用在屬性上，描述響應類的屬性