PHP_DOC 實時生成 API 文檔

隨著API的迅速發展,如何編寫出更加規范的API文檔說明則顯的尤為重要。

你是否還通過手寫的方式來生成和編寫這些文檔呢?

那么你就OUT啦!

工欲善其事,必先利其器。

本文分享一款工具:PHP_DOC

可在線實時查看API接口的參數、返回和說明,無須手動維護文檔。

背景

你還在為維護 API文檔 而煩惱嗎?

維護 客戶端 接口。

維護 Rpc 接口。

...

那么問題來了,

能不能根據代碼進行生成API文檔呢?

能不能生成高逼格的界面來進行展示呢?

能不能適合不同框架的系統呢?

原理

首先用程序分析代碼的注釋,然后進行友好的展示。

實現

(1) 列出所有的API文件。
(2) 點擊文件名,可以查看里面的接口。
(3) 點擊接口名稱,可以查看接口的注釋。

效果圖

PHP_DOC 實時生成 API 文檔.gif

Thanks ~

如果大家想下載源碼,歡迎大家Q我(留言、私信均可) ~

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 隨著API的迅速發展,如何編寫出更加規范的API文檔說明則顯的尤為重要。你是否還通過手寫的方式來生成和編寫這些文檔...
    茶藝瑤閱讀 902評論 0 0
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,991評論 19 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,556評論 25 708
  • 之前的兩篇文章已經提到過,如今我已經完成了“堅持晨跑365天”的自我挑戰,學到了很多跑步的知識,領悟到了堅持的意義...
    望月塵閱讀 3,837評論 11 26
  • 近了 近了 我摸到了陽光的暖意 聽到了孩子的歡聲 還有還有那街角流浪的貓 只是看不到春風里的風箏 是不夠近嗎 是不...
    希茶一夢閱讀 341評論 0 4