注解生成Api接口文檔，自動(dòng)注冊(cè)路由、在線調(diào)試、Markdown文檔

待更新 版本

待更新 版本更新時(shí)間

待更新 安裝

205 star

v5版本已內(nèi)置兼容Webman

簡(jiǎn)介

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

特性

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

安裝

1、安裝擴(kuò)展

進(jìn)入項(xiàng)目根目錄，執(zhí)行如下命令：

composer require hg/apidoc

2、添加前端頁(yè)面

點(diǎn)擊此處，前往前端文件下載頁(yè)面

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

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

3、配置異常響應(yīng)

由于框架會(huì)對(duì)全局異常進(jìn)行處理，如apidoc的異常未被正確響應(yīng)，會(huì)導(dǎo)致頁(yè)面打不開或報(bào)錯(cuò)，配置以下異常處理來(lái)解決問(wèn)題。

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

// 找到你的項(xiàng)目所配置的異常處理類，本示例為
// support/ExceptionHandle.php
public function render(Request $request, Throwable $exception): Response
{
    // Apidoc異常處理響應(yīng)
    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);
}