Restful風格文件管理工具的選擇依據：

• 團隊協作修改API介面
• 生成word、pdf、html等形式的介面文件
• 可以內線搭建自己的API介面文件管理系統
• 最好能夠內線進行介面的測試工作

文件管理和自動化介面測試方案

• 方案一、Swagger
• 方案二、APIDOC + Postman（chrome外掛）
• 方案三、APIDOC + Http Client

Swagger官方站點：

APIDOC官方站點：

方案一、Swagger

Swagger 方案整合在專案中，隨行專案進行釋出，附帶介面測試環境

1.引入 Swagger 的 Maven 依賴

        <!-- swagger2 start -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency
 
>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <!-- swagger2 end -->

2.在Spring 專案中配置 Swagger

/**
 * Description： Swagger2構建強大的RESTful API文件
 * <br />Author： vimx86
 */
 

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.galsang.admin.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("RESTful APIs For lxy-admin ")
                .description("lxy-admin")
                .termsOfServiceUrl("https://gitee.com/vimx86")
                .contact("vimx86")
                .version("1.0")
                .build();
    }

}

3. 使用Swagger 進行協作

方案二、APIDOC + Postman（chrome外掛）

1.下載nodejs環境

nodejs安裝過程略

2.安裝apidoc

npm install apidoc -g

3.Demo

專案所在路徑 E:\workspace\testhttp

apidoc -i E:\workspace\testhttp\ -o E:\workspace\testhttp\apidoc\ -t E:\workspace\mytemplate -f ..java−f.\.js

apidoc -i E:\workspace\testhttp\ -o E:\workspace\testhttp\apidoc\ -t E:\workspace\mytemplate

apidoc -i E:\workspace\cmp\ -o E:\workspace\cmp\apidoc\ -t E:\workspace\mytemplate -f ..java$

4. apidoc 命令

-i （input）指定掃描專案的路徑
-o （output）指定文件生成的路徑
-t （template）指定文件生成的模板
-f （file-filters）掃描指定型別的檔案

5.apidoc開發工具的整合和Swagger文件的轉換

eclipse整合

Swagger文件的轉換

6.Postman（chrome外掛）

如果能夠訪問google 請在google應用商店中

如果不能訪問google，請到Postman官方網站下載 https://www.getpostman.com/

方案三、APIDOC + Http Client

原理同方案二、APIDOC + Postman（chrome外掛）
- Postman（chrome外掛）

- Http Client 實現Postman類似的功能，可以根據自己專案的實際情況進行改造（如沒有擴充套件需求，建議使用Postman，Postman滿足當前絕大多數使用情況）

自動化部署方案設計（使用APIDOC）

• 當代碼提交到SVN或GIT伺服器完成時
• 執行文件生成命令，生成到指定的檔案目錄
• 搭建線上文件Web伺服器，web伺服器目錄同文檔生成目錄

自動化部署方案設計（使用Swagger ）

• 使用Swagger 方案整合在專案中，隨行專案進行釋出，不需要單獨部署

以上兩種方式各有利弊，請結合自身業務進行方案的合理規劃。

PS: 以上兩種都沒有符合選擇依據，具體實施方案可以根據人力物力需求進行規劃實施。

*************************************************************************************************

文中有不妥或者錯誤的地方還望指出。
如果你有更好的建議，可以給我留言討論，共同進步！ 感謝您耐心的讀完本篇文章。
【版權所有，轉載請註明原文連結。】

*************************************************************************************************