ApiDoc

介紹

APIDOC是在HTML，PHP和JQUERY中製成的模板，可幫助使用PHP REST API文檔。

安裝

將下面的鏈接複製到您的命令行以下載最新版本。無需在計算機上安裝Apidoc，只需克隆文件並將其解壓縮到服務器文件夾即可。

$ git clone -b 2.0.0-stable --single-branch https://github.com/brennoDuarte/ApiDoc.git ApiDoc-v2.0.0-stable

確保在瀏覽器中啟用JavaScript。您可以打開深色模式，但是一旦您重新加載頁面，它就會關閉。

配置

JSON文件在“ JSON”文件夾中。

您可以編輯文件“ config.json”，如下：

• “ appname” ：您的項目名稱，
• “版本” ：您的項目版本，
• “描述” ：您的API的簡要說明，
• “語言” ：製作API的語言，
• “協議” ：您的API協議，HTTP或HTTPS，

要編輯默認路由，請更改“ router.json”文件。 URL會話細分為：

• “ pathName” ：終點的主要路由，
• “ ID” ：通過單擊路由按鈕顯示的模態ID。請記住為每個端點編輯其他ID，否則不會顯示ID，
• “ pathget/getID/post/put/delete” ：API的端點，
• “ descriptionget/post/put/delete” ：端點的簡要說明，
• “鏈接” ：端點的鏈接。單擊它將在新標籤中打開。

要添加新路徑，請將“路徑名”複製到“ config.json”文件中，然後將其粘貼到其他路徑下方。

如果您有多個路線（獲取，發布，放置，刪除），請使用自定義路線。您可以為此編輯CustomRouter.json文件：

• “ CustomRouter” ：從您的端點命名主要路由，
• “ type” ：獲取，發布，放置，刪除或其他，
• “路徑” ：API的端點，
• “描述” ：您的終點的簡要說明，
• “鏈接” ：端點的鏈接。單擊它將在新標籤中打開。

如果您的API沒有某個請求，請將字段更改為null。例子：

 " post " : {
    " id " : null,
    " pathPost " : null,
    " descriptionPost " : null,
    " link " : null
},

完成，只需在任何瀏覽中打開apidoc.php文件即可。