摘要:目前支持的變成語言有,,,等,主流的編成語言都支持。文件時你要生成文檔的目錄,也是最后要使用的目錄。是一項免費的服務,它允許你把你的靜態頁面發布出去共其他用戶通過瀏覽器查看。
你的項目在用什么工具書寫api文檔?今天就來給大家推薦下ApiDoc1. ApiDoc是什么? ApiDoc可以根據你再代碼里的注釋,來生成api描述文檔,這樣就不用你自己去告訴端的小伙伴該怎么調用你的api了。目前支持的變成語言有:Java,Javascript,Php,Python,C#,Ruby,Lua等,主流的編成語言都支持。 2. 怎么用? 很簡單,只要在你的代碼里用這樣的注解申明你的接口信息就好
/** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */這里面的這些注解都是ApiDoc定義好的,你只要按照官方文檔使用就好了。ApiDoc 官網 3. 開始搞起來
安裝
npm install apidoc -g
運行
apidoc -i api/ -o docs/
api是你的代碼目錄也就是你使用注釋的文件目錄,它會自動掃描使用注解的文件。docs文件時你要生成api文檔的目錄,也是github page最后要使用的目錄。
檢查api文檔
在docs目錄下直接打開index.html就可以查看最終結果了。
創建github倉庫
將自己的生成后的戴阿曼上船,就是docs整個目錄
在倉庫的 setting中開啟page服務
用page提供的url去訪問
總結ApiDoc提供了更好的api文檔閱讀體驗,對于開發者來說免去了寫文檔的麻煩。不過不足就是不能像swagger那樣提供在線調試,而且要想描述一個api需要些很多的注釋。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/72424.html
摘要:目前支持的變成語言有,,,等,主流的編成語言都支持。文件時你要生成文檔的目錄,也是最后要使用的目錄。是一項免費的服務,它允許你把你的靜態頁面發布出去共其他用戶通過瀏覽器查看。 你的項目在用什么工具書寫api文檔?今天就來給大家推薦下ApiDoc 1. ApiDoc是什么? ApiDoc可以根據你再代碼里的注釋,來生成api描述文檔,這樣就不用你自己去告訴端的小伙伴該怎么調用你的api了...
摘要:目前支持的變成語言有,,,等,主流的編成語言都支持。文件時你要生成文檔的目錄,也是最后要使用的目錄。是一項免費的服務,它允許你把你的靜態頁面發布出去共其他用戶通過瀏覽器查看。 你的項目在用什么工具書寫api文檔?今天就來給大家推薦下ApiDoc 1. ApiDoc是什么? ApiDoc可以根據你再代碼里的注釋,來生成api描述文檔,這樣就不用你自己去告訴端的小伙伴該怎么調用你的api了...
摘要:國外的話國內的國內開源的非常好用的一款文檔管理系統,安裝也非常方便,只需將源代碼放到項目目錄下自動安裝運行即可,不要要注意版本必須大于界面簡潔功能強大的阿里的接口管理工具,開源免費,接口自動化,數據自動生成,自動化測試,企業級管理。 在項目中,需要協同開發,所以會寫許多API文檔給其他同事,以前都是寫一個簡單的TXT文本或Word文檔,口口相傳,這種方式比較老土了,所以,需要有個api...
摘要:影響我寫文檔的原因可能是代碼和文檔分離,有時候寫完代碼會忘記補文檔,而且不能及時查看,使用可以解決我的問題,這個插件可以根據代碼注釋生成文檔頁面,代碼注釋改動文檔可以及時更新,而且支持離線文檔下載。 影響我寫文檔的原因可能是代碼和文檔分離,有時候寫完代碼會忘記補文檔,而且不能及時查看,使用 Flask-Docs 可以解決我的問題,這個插件可以根據代碼注釋生成文檔頁面,代碼注釋改動文檔可...
閱讀 3872·2021-09-27 13:35
閱讀 1069·2021-09-24 09:48
閱讀 2899·2021-09-22 15:42
閱讀 2339·2021-09-22 15:28
閱讀 3145·2019-08-30 15:43
閱讀 2609·2019-08-30 13:52
閱讀 2971·2019-08-29 12:48
閱讀 1451·2019-08-26 13:55