注解生成Api接口文檔，自動注冊路由、在線調試、Markdown文檔

待更新 版本

待更新 版本更新時間

待更新 安裝

207 star

v5版本已內置兼容Webman

簡介

Apidoc是一個通過解析注解生成Api接口文檔的PHP composer擴展；內置兼容Laravel、ThinkPHP、Webman、Hyperf框架。
全面的注解引用、數據表字段引用，簡單的注解即可生成Api文檔，而Apidoc不僅于接口文檔，在線接口調試、Mock調試數據、調試事件處理、Json/TypeScript生成、批量測試、接口分享、代碼生成器、Api市場等諸多實用功能，致力于提高Api接口開發(fā)效率。

特性

開箱即用：無繁雜的配置、安裝后按文檔編寫注釋即可自動生成API文檔。
兼容度高：兼容多框架、支持PHP8原生注解。
輕松編寫：支持通用注釋引用、業(yè)務邏輯層、數據表字段的引用，幾句注釋即可完成。
在線調試：在線文檔可直接調試，并支持全局請求/Mock參數/事件處理，接口調試省時省力。
安全高效：支持訪問密碼驗證、應用/版本獨立密碼；支持文檔緩存。
多應用/多版本：可適應各種單應用、多應用、多版本的項目的Api管理。
分組/Tag：可對控制器/接口進行多級分組或定義Tag。
Markdown文檔：支持.md文件的文檔展示。
Json/TypeScript生成：文檔自動生成接口的Json及TypeScript。
代碼生成器：配置+模板即可快速生成代碼及數據表的創(chuàng)建，大大提高工作效率。

安裝

1、安裝擴展

進入項目根目錄，執(zhí)行如下命令：

composer require hg/apidoc

2、添加前端頁面

點擊此處，前往前端文件下載頁面

下載完成后解壓，將apidoc文件夾拷貝到你的項目 public 目錄下

打開瀏覽器訪問 http://你的域名/apidoc/index.html ，出現接口文檔頁面，表示安裝成功。

3、配置異常響應

由于框架會對全局異常進行處理，如apidoc的異常未被正確響應，會導致頁面打不開或報錯，配置以下異常處理來解決問題。

參考Webman官方文檔找到你項目的異常處理類，或創(chuàng)建異常處理類

// 找到你的項目所配置的異常處理類，本示例為
// support/ExceptionHandle.php
public function render(Request $request, Throwable $exception): Response
{
    // Apidoc異常處理響應
    if ($exception instanceof \hg\apidoc\exception\HttpException) {
        return response(json_encode([
            "code" => $exception->getCode(),
            "message" => $exception->getMessage(),
        ],JSON_UNESCAPED_UNICODE), $exception->getStatusCode());
    }
    return parent::render($request, $exception);
}