PHP_DOC 實時生成 API 文件 | 掘金技術徵文

訢亮發表於2017-01-22

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

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

那麼你就OUT啦!

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

本文分享一款工具:PHP_DOC

可線上實時檢視API介面的引數、返回和說明,無須手動維護文件

背景

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

維護 客戶端 介面。

維護 Rpc 介面。

...

那麼問題來了,

能不能根據程式碼進行生成API文件呢?

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

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

原理

首先用程式分析程式碼的註釋,然後進行友好的展示。

實現

(1) 列出所有的API檔案。
(2) 點選檔名,可以檢視裡面的介面。
(3) 點選介面名稱,可以檢視介面的註釋。

效果圖

PHP_DOC 實時生成 API 文件 | 掘金技術徵文

PHP_DOC 實時生成 API 文件 | 掘金技術徵文

PHP_DOC 實時生成 API 文件 | 掘金技術徵文

PHP_DOC 實時生成 API 文件 | 掘金技術徵文

PHP_DOC 實時生成 API 文件 | 掘金技術徵文
PHP_DOC 實時生成 API 文件.gif

如果大家需要下載原始碼,可以關注微信公眾號,回覆 “php_doc” 即可。

Thanks ~


作者:PHP後端開發者

免費提供技術諮詢服務(自己懂的知識)。

QQ群:564557094。

關注微信公眾號,留言即可,看到留言後會及時回覆。

PHP_DOC 實時生成 API 文件 | 掘金技術徵文
IT小圈兒

掘金技術徵文:gold.xitu.io/post/587f0e…

相關文章