基於php開發的RESTful ApiDoc文件

2021-07-30 08:00:04 字數 1022 閱讀 2653

apidoc基於rest的web api文件生成器,可以根據**注釋生成web api文件,自動生成靜態的html網頁文件,不僅支援專案版本號,還支援api版本號。

使用apidoc不需要自己麻煩的調word的格式,就可以生成乙份漂亮的api文件。既美觀又可以裝逼。。。先看效果

1、安裝:

php執行環境:php(5.5.12) +  apidoc 。apidoc的安裝我們可以通過 npm 命令來安裝。apidoc基於nodejs實現,所以你需先有nodejs及npm環境   windows安裝node如下,直接下一步即可:

通過在命令列模式下,node -v即可檢視當前node的版本、npm -v 即可檢視當前 node 整合的 npm 的版本。

2、新建乙個apidoc的目錄,並進入當前目錄。執行 npm install apidoc 即可完成 apidoc模組的安裝。

此時所有準備工作已經完成,就可以進入編寫apidoc文件的工作了。

3、通過編寫apidoc.json 和 test.php檔案,然後在命令列下,執行命令  apidoc test.php  即可生成乙個doc目錄。

注意:通過此命令 apidoc test.php 生成的文件會包含預設的模板內容,修改  api_data.json、api_data.js檔案,刪除多餘內容即可。

官網主頁: 

github: 

restful開發教程

restful架構,就是目前最流行的一種網際網路軟體架構。它結構清晰 符合標準 易於理解 擴充套件方便,所以正得到越來越多 的採用。restful 即representational state transfer的縮寫 其實是乙個開發理念,是對http的很好的詮釋。非rest的url http qu...

Restful風格開發

全稱 representational state transfer 強制翻譯 表述性狀態轉移 傳輸 1.restful 是一種風格 而非一種標準 2.根據此風格設計的軟體更簡潔且有層次 3.與rest 並列的方案 soap,rpc 4.以最適合使用者的任意形式將資源傳輸出去 1 使用者 可以是客戶...

基於JSON的RESTful介面協議

xml的格式可以改為json格式 對於restful api來講,我們已經解決了傳輸協議的問題 基於http,協議約定問題 基於json。最後要解決的是服務發現問題。有個著名的基於restful api 的跨系統呼叫框架叫spring cloud,在spring cloud中有乙個元件叫eureka...