Swagger2 的正確玩法是什么

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)碛嘘P(guān)Swagger2 的正確玩法是什么，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

Swagger2簡(jiǎn)介

簡(jiǎn)單的來說，Swagger2的誕生就是為了解決前后端開發(fā)人員進(jìn)行交流的時(shí)候API文檔難以維護(hù)的痛點(diǎn)，它可以和我們的Java程序完美的結(jié)合在一起，并且可以與我們的另一開發(fā)利器Spring Boot來配合使用。

開始使用

第一步：導(dǎo)入POM文件

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

        <!-- 這里使用 swagger-bootstrap-ui 替代了原有丑陋的ui，拯救處女座~ -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.0</version>
        </dependency>

#### 第二步：添加配置類

我們需要新增一個(gè)Swagger2Config 的配置類：

/**
 *    Swagger2 配置類
 * @author vi    
 * @since 2019/3/6 8:31 PM
 */
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("indi.viyoung.viboot.*"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("viboot-swagger2")    //標(biāo)題
                .description("Restful-API-Doc")    //描述
                .termsOfServiceUrl("https://www.cnblogs.com/viyoung") //這里配置的是服務(wù)網(wǎng)站，我寫的是我的博客園站點(diǎn)~歡迎關(guān)注~
                .contact(new Contact("Vi的技術(shù)博客", "https://www.cnblogs.com/viyoung", "18530069930@163.com")) // 三個(gè)參數(shù)依次是姓名，個(gè)人網(wǎng)站，郵箱
                .version("1.0") //版本
                .build();
    }
}

第三步：在啟動(dòng)類中添加配置

注意一定要記得添加@EnableSwagger2注解

/**
 * @author vi
 * @since 2019/3/6 6:35 PM
 */
@SpringBootApplication
@ComponentScan(value = "indi.viyoung.viboot.*")
@MapperScan(value = "indi.viyoung.viboot.swagger2.mapper")
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class ViBootSwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ViBootSwaggerApplication.class, args);
    }
}

第四步：通過注解來完成API文檔

1. @Api

舉個(gè)????：

@Api(value = "用戶類控制器",tags="用戶類控制器")
public class UserController {
...
}

2 . @ApiOperation

舉個(gè)????：

     @ApiOperation(value = "獲取用戶列表",notes = "獲取用戶列表")
    public List<User> get() {
         ...   
    }

3. @ApiParam

舉個(gè)????：

    @ApiOperation(value="獲取用戶詳細(xì)信息", notes="根據(jù)url的id來獲取用戶詳細(xì)信息")
    public User get(@ApiParam(name="id",value="用戶id",required=true) Long id) {
        log.info("GET..{}...方法執(zhí)行。。。",id);
        return userService.getById(id);
    }

4. @ApiModel && @ApiModelProperty

舉個(gè)????：

@ApiModel(value="user對(duì)象",description="用戶對(duì)象user")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    @ApiModelProperty(value = "用戶ID",example = "1000001",hidden=true)
    private Long id;

    @ApiModelProperty(value="用戶名",required = true,dataType = "String")
    private String userName;

    @ApiModelProperty(value = "密碼")
    private String password;
}

5. @ApiImplicitParam && @ApiImplicitParams

`@ApiImplicitParam`可以單個(gè)用于方法至上，多個(gè)參數(shù)的話可以把`@ApiImplicitParam`放到`@ApiImplicitParams`中，這里只羅列`@ApiImplicitParam`的屬性：

舉個(gè)????：

    @ApiImplicitParams({
            @ApiImplicitParam(name = "user", value = "用戶實(shí)體user", required = true, dataType = "User")
    })
    public void put(User user) {
        userService.updateById(user);
        log.info("PUT方法執(zhí)行。。。");
    }

這里需要注意一點(diǎn)，我們并沒有在注解中寫圖中圈中的兩個(gè)參數(shù)，這個(gè)是去讀取了我們剛剛為User類的注解，并將用戶名設(shè)置為必填！

6.@ApiResposne && @ApiResponses

@ApiResponses與@ApiResponse的關(guān)系和@ApiImplicitParam && @ApiImplicitParams 的關(guān)系和用法都是類似的

最后再聊聊這個(gè)UI

先貼幾張spring-fox的ui（正是我們所熟知的那一套）

相信看到這里，大家心里對(duì)于這兩套UI的選擇應(yīng)該都有個(gè)答案了，當(dāng)然bootstrap風(fēng)格的ui不僅好看，而且有各種強(qiáng)大的功能~

1. 導(dǎo)出md文檔

   

2. 參數(shù)緩存

   

上述就是小編為大家分享的Swagger2 的正確玩法是什么了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道。