摘要:隨著的迅速發(fā)展,如何編寫出更加規(guī)范的文檔說明則顯的尤為重要。你是否還通過手寫的方式來生成和編寫這些文檔呢那么你就啦工欲善其事,必先利其器。可在線實(shí)時(shí)查看接口的參數(shù)返回和說明,無須手動(dòng)維護(hù)文檔。實(shí)現(xiàn)列出所有的文件。
隨著API的迅速發(fā)展,如何編寫出更加規(guī)范的API文檔說明則顯的尤為重要。
你是否還通過手寫的方式來生成和編寫這些文檔呢?
那么你就OUT啦!
工欲善其事,必先利其器。
本文分享一款工具:PHP_DOC。
可在線實(shí)時(shí)查看API接口的參數(shù)、返回和說明,無須手動(dòng)維護(hù)文檔。
背景
你還在為維護(hù) API文檔 而煩惱嗎?
維護(hù) 客戶端 接口。
維護(hù) Rpc 接口。
...
那么問題來了,
能不能根據(jù)代碼進(jìn)行生成API文檔呢?
能不能生成高逼格的界面來進(jìn)行展示呢?
能不能適合不同框架的系統(tǒng)呢?
原理
首先用程序分析代碼的注釋,然后進(jìn)行友好的展示。
實(shí)現(xiàn)
(1) 列出所有的API文件。
(2) 點(diǎn)擊文件名,可以查看里面的接口。
(3) 點(diǎn)擊接口名稱,可以查看接口的注釋。
效果圖
圖1
圖2
圖3
圖4
PHP_DOC 實(shí)時(shí)生成 API 文檔 GIF
如果大家需要下載源碼,可以關(guān)注微信公眾號(hào),回復(fù) “php_doc” 即可。
Thanks ~
系統(tǒng)的講解 - SSO 單點(diǎn)登錄
系統(tǒng)的講解 - PHP WEB 安全防御
系統(tǒng)的講解 - PHP 緩存技術(shù)
系統(tǒng)的講解 - PHP 接口簽名驗(yàn)證
系統(tǒng)的講解 - PHP 浮點(diǎn)數(shù)高精度運(yùn)算
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://m.specialneedsforspecialkids.com/yun/30546.html
摘要:國(guó)外的話國(guó)內(nèi)的國(guó)內(nèi)開源的非常好用的一款文檔管理系統(tǒng),安裝也非常方便,只需將源代碼放到項(xiàng)目目錄下自動(dòng)安裝運(yùn)行即可,不要要注意版本必須大于界面簡(jiǎn)潔功能強(qiáng)大的阿里的接口管理工具,開源免費(fèi),接口自動(dòng)化,數(shù)據(jù)自動(dòng)生成,自動(dòng)化測(cè)試,企業(yè)級(jí)管理。 在項(xiàng)目中,需要協(xié)同開發(fā),所以會(huì)寫許多API文檔給其他同事,以前都是寫一個(gè)簡(jiǎn)單的TXT文本或Word文檔,口口相傳,這種方式比較老土了,所以,需要有個(gè)api...
摘要:發(fā)布于之后,采用了完全不同的方式,使用函數(shù)定義任務(wù)。它允許開發(fā)者使用它們的補(bǔ)丁和更新來修復(fù)這些安全漏洞。提供了工具用于掃描依賴來監(jiān)測(cè)漏洞。是一個(gè)開源診斷工具,用于和應(yīng)用。是和開發(fā)的一款新的包管理工具。與相比,它解決了安全性能以及一致性問題。 譯者按: 最全的JavaScript開發(fā)工具列表,總有一款適合你! 原文: THE ULTIMATE LIST OF JAVASCRIPT TOO...
摘要:同時(shí)還有對(duì)應(yīng)的返回值字段描述通過這個(gè)方法,可以隨時(shí)隨地的測(cè)試以及更新文檔,簡(jiǎn)直是后端小伙伴的福音但是,不知道小伙伴們有沒有發(fā)現(xiàn)一個(gè)問題,就是在生成接口文檔的時(shí)候,還是需要自己填寫參數(shù)描述。對(duì)于測(cè)試同學(xué)來說,這是一個(gè)非常不錯(cuò)的功能。 我們都知道在一個(gè)團(tuán)隊(duì)中是由很多角色組成的,例如:業(yè)務(wù)、產(chǎn)品、...
摘要:其標(biāo)準(zhǔn)為前身是,提供強(qiáng)大的在線編輯功能,包括語法高亮錯(cuò)誤提示自動(dòng)完成實(shí)時(shí)預(yù)覽,并且支持用戶以格式撰寫導(dǎo)入導(dǎo)出轉(zhuǎn)換文檔。 團(tuán)隊(duì)內(nèi)部RestAPI開發(fā)采用設(shè)計(jì)驅(qū)動(dòng)開發(fā)的模式,即使用API設(shè)計(jì)文檔解耦前端和后端的開發(fā)過程,雙方只在聯(lián)調(diào)與測(cè)試時(shí)耦合。在實(shí)際開發(fā)和與前端合作的過程中,受限于眾多因素的影響,開發(fā)效率還有進(jìn)一步提高的空間。本文的目的是優(yōu)化工具鏈支持,減少一部分重復(fù)和枯燥的勞動(dòng)。 現(xiàn)狀...
摘要:通過集成,可以從零開始,快速搭建出實(shí)時(shí)音視頻通信平臺(tái),可以應(yīng)用于語音和視頻社交在線教育和培訓(xùn)遠(yuǎn)程醫(yī)療在線會(huì)議直播等多種業(yè)務(wù)場(chǎng)景。使用服務(wù)之前,首先需要注冊(cè)賬號(hào)并且完成實(shí)名認(rèn)證。確定后,自動(dòng)生成。推流成功后,即可直播觀看視頻。通過集成URTC SDK,可以從零開始,快速搭建出實(shí)時(shí)音視頻通信平臺(tái),可以應(yīng)用于語音和視頻社交、在線教育和培訓(xùn)、遠(yuǎn)程醫(yī)療、在線會(huì)議、直播等多種業(yè)務(wù)場(chǎng)景。 集成URTC S...
閱讀 3781·2021-11-23 09:51
閱讀 4417·2021-11-15 11:37
閱讀 3530·2021-09-02 15:21
閱讀 2754·2021-09-01 10:31
閱讀 886·2021-08-31 14:19
閱讀 861·2021-08-11 11:20
閱讀 3315·2021-07-30 15:30
閱讀 1696·2019-08-30 15:54