PHP_DOC 實時生成 API 文檔

bigdevil_s 發布于2019-07-01 12:21 / 520人閱讀

摘要：隨著的迅速發展，如何編寫出更加規范的文檔說明則顯的尤為重要。你是否還通過手寫的方式來生成和編寫這些文檔呢那么你就啦工欲善其事，必先利其器。可在線實時查看接口的參數返回和說明，無須手動維護文檔。實現列出所有的文件。

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

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

那么你就OUT啦！

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

本文分享一款工具：PHP_DOC。

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

背景

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

維護客戶端接口。

維護 Rpc 接口。

...

那么問題來了，

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

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

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

原理

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

實現

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

效果圖

圖1

圖2

圖3

圖4

PHP_DOC 實時生成 API 文檔 GIF

如果大家需要下載源碼，可以關注微信公眾號，回復 “php_doc” 即可。

Thanks ~

推薦閱讀

系統的講解 - SSO 單點登錄

系統的講解 - PHP WEB 安全防御

系統的講解 - PHP 緩存技術

系統的講解 - PHP 接口簽名驗證

系統的講解 - PHP 浮點數高精度運算

云服務器 GPU云服務器生成API文檔文檔生成 python生成文檔 python文檔生成

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/30546.html

開源的api文檔管理系統

摘要：國外的話國內的國內開源的非常好用的一款文檔管理系統，安裝也非常方便，只需將源代碼放到項目目錄下自動安裝運行即可，不要要注意版本必須大于界面簡潔功能強大的阿里的接口管理工具，開源免費，接口自動化，數據自動生成，自動化測試，企業級管理。在項目中，需要協同開發，所以會寫許多API文檔給其他同事，以前都是寫一個簡單的TXT文本或Word文檔，口口相傳，這種方式比較老土了，所以，需要有個api...

zsirfs 2019-06-27 14:58 評論0 收藏0
JavaScript開發工具大全

摘要：發布于之后，采用了完全不同的方式，使用函數定義任務。它允許開發者使用它們的補丁和更新來修復這些安全漏洞。提供了工具用于掃描依賴來監測漏洞。是一個開源診斷工具，用于和應用。是和開發的一款新的包管理工具。與相比，它解決了安全性能以及一致性問題。譯者按: 最全的JavaScript開發工具列表，總有一款適合你！原文: THE ULTIMATE LIST OF JAVASCRIPT TOO...

nifhlheimr 2019-08-20 17:34 評論0 收藏0
ApiPost與PostMan，你可以任選一款不錯的接口管理工具

摘要：同時還有對應的返回值字段描述通過這個方法，可以隨時隨地的測試以及更新文檔，簡直是后端小伙伴的福音但是，不知道小伙伴們有沒有發現一個問題，就是在生成接口文檔的時候，還是需要自己填寫參數描述。對于測試同學來說，這是一個非常不錯的功能。我們都知道在一個團隊中是由很多角色組成的，例如：業務、產品、...

crossoverJie 2021-09-29 09:34 評論0 收藏0
【效率專精系列】善用API統一描述語言提升RestAPI開發效率

摘要：其標準為前身是，提供強大的在線編輯功能，包括語法高亮錯誤提示自動完成實時預覽，并且支持用戶以格式撰寫導入導出轉換文檔。團隊內部RestAPI開發采用設計驅動開發的模式，即使用API設計文檔解耦前端和后端的開發過程，雙方只在聯調與測試時耦合。在實際開發和與前端合作的過程中，受限于眾多因素的影響，開發效率還有進一步提高的空間。本文的目的是優化工具鏈支持，減少一部分重復和枯燥的勞動。現狀...

tianyu 2019-08-16 10:42 評論0 收藏0
5分鐘快速集成UCloud實時音視頻服務URTC-Linux Ubuntu端

摘要：通過集成，可以從零開始，快速搭建出實時音視頻通信平臺，可以應用于語音和視頻社交在線教育和培訓遠程醫療在線會議直播等多種業務場景。使用服務之前，首先需要注冊賬號并且完成實名認證。確定后，自動生成。推流成功后，即可直播觀看視頻。通過集成URTC SDK，可以從零開始，快速搭建出實時音視頻通信平臺，可以應用于語音和視頻社交、在線教育和培訓、遠程醫療、在線會議、直播等多種業務場景。集成URTC S...

Tecode 2022-06-28 18:59 評論0 收藏0