大家在進行Java學習的時候，也要學習一些API工具的使用。目前市場有哪些比較優秀的接口文檔管理工具呢?Swagger Api接口文檔工具到底如何，大致匯總一下吧!

1.Swagger

說到Swagger，他確實是為開發者發明的一款神器，他可以實現自動生成 API 接口文檔，在線調試，非常的方便。Swagger 官方文檔: https://swagger.io/。 項目接入： pom依賴：

    <dependency>        <groupId>io.springfoxgroupId>        <artifactId>springfox-swagger2artifactId>        <version>2.4.0version>    dependency>    <dependency>        <groupId>io.springfoxgroupId>        <artifactId>springfox-swagger-uiartifactId>        <version>2.4.0version>    dependency>

配置信息：

@Configuration@EnableWebMvc@EnableSwagger2public class SwaggerConfig extends WebMvcConfigurerAdapter {    @Bean    public Docket buildDocket() {        Docket docket =  new Docket(DocumentationType.SWAGGER_2)                .apiInfo(buildApiInf());        docket = docket.select()                .apis(RequestHandlerSelectors.any())//controller路徑                .paths(PathSelectors.any()).build();        return docket;    }    @Override    public void addResourceHandlers(ResourceHandlerRegistry registry) {        registry.addResourceHandler("swagger-ui.html")                .addResourceLocations("classpath:/META-INF/resources/");          registry.addResourceHandler("/webjars/**")                 .addResourceLocations("classpath:/META-INF/resources/webjars/");    }    private ApiInfo buildApiInf() {        return new ApiInfoBuilder()                .title("RestAPI Docs")                .termsOfServiceUrl("http://www.github.com/kongchen/swagger-maven-plugin")                .build();    }}

Controller里的配置(例如)：

@Api(value="客戶API",tags={"客戶API"})@RestController@RequestMapping("/api/customer/")public class CustomerController {    /**   * 更新采購商資料   *    * @return   * @throws Exception   */  @ApiOperation(value="更新商戶信息", notes="根據Customer對象更新,SON格式：{\"id\":1,\"customerType\":\"..\",...}")  @ApiImplicitParam(name = "Json", value = "", dataType = "Json",required = true)  @ResponseBody  @RequestMapping(value="update", method=RequestMethod.POST, produces = {"application/json;charset=UTF-8"})  public JSONObject updateCustomer(HttpServletRequest request) throws Exception{        //TODO 代碼邏輯  }}

啟動項目，打開swagger,界面：http://192.168.1.101:9001/swagger-ui.html，

再看看剛配置的接口：

Swagger的接入特別簡單，還可以在線調試。

2.apizza

Apizza也是我們項目中使用過的，是從Swagger 轉到Apizza。而卻他是極客專屬的api協作管理工具，免費的團隊協作，在線模擬調試，快速生成api文檔，導出離線版文檔。

項目Api接入：

只需在Apizza官網(https://apizza.net)申請賬號，創建項目，并手寫添加接口文檔。

主要功能

api跨域調試量身定制的chrome插件，本地，在線接口，都可以調。

云端存儲，企業安全版支持本地數據中心。

一鍵分享，與團隊共享你的API文檔。

支持Postman，Swagger格式 導入Postman/Swagger Json 生成文檔。

導出離線文檔，部署本地服務器。

api Mock 根據文檔自動生成返回結果，提供獨立URL方便前端測試。

支持多種文檔 http接口文檔，markdown說明文檔。

Apizza接口文檔工具有一個很大不足的地方，那是Apizza個人免費版有人數限制，所有超過8人的團隊如果想免費用，你是不用考慮Apizza的。

3.Yapi

Yapi是去哪兒網開源的一款接口管理工具。Yapi旨意將接口作為一個公共的可視化的方式打通前端、后臺、測試環節，整合在一塊，共同使用維護，提高接口的維護成本。Yapi是一款免費開源的Api接口文檔工具，需要下載部署在自己的服務器上。

主要特點如下：

權限管理 YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求;

可視化接口管理 基于 websocket 的多人協作接口編輯功能和類 postman 測試工具，讓多人協作成倍提升開發效率;

Mock Server 易用的 Mock Server，再也不用擔心 mock 數據的生成了;

自動化測試 完善的接口自動化測試,保證數據的正確性;

數據導入 支持導入 swagger, postman, har 數據格式，方便遷移舊項目;

插件機制 強大的插件機制，滿足各類業務需求;

這里關于Yapi的安裝就不詳細介紹了。Yapi安裝需事先安裝 nodejs、 mongodb、git應用。 這篇主要講了Api接口文檔工具，整體來說，感覺這三款都不錯。大家如果對Java感興趣，不妨關注一下動力節點的Java API文檔，里面有很多知識都是可以在線學習的，希望對大家能夠有所幫助。