亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專(zhuān)欄INFORMATION COLUMN

ApiDoc + github page 使用

ytwman / 1244人閱讀

摘要：目前支持的變成語(yǔ)言有，，，等，主流的編成語(yǔ)言都支持。文件時(shí)你要生成文檔的目錄，也是最后要使用的目錄。是一項(xiàng)免費(fèi)的服務(wù)，它允許你把你的靜態(tài)頁(yè)面發(fā)布出去共其他用戶(hù)通過(guò)瀏覽器查看。

你的項(xiàng)目在用什么工具書(shū)寫(xiě)api文檔？今天就來(lái)給大家推薦下ApiDoc
1. ApiDoc是什么？ ApiDoc可以根據(jù)你再代碼里的注釋?zhuān)瑏?lái)生成api描述文檔，這樣就不用你自己去告訴端的小伙伴該怎么調(diào)用你的api了。目前支持的變成語(yǔ)言有：Java，Javascript，Php，Python,C#,Ruby,Lua等，主流的編成語(yǔ)言都支持。 2. 怎么用？ 很簡(jiǎn)單，只要在你的代碼里用這樣的注解申明你的接口信息就好 
/**
 * @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 官網(wǎng) 3. 開(kāi)始搞起來(lái)

安裝

npm install apidoc -g

運(yùn)行

apidoc -i api/ -o docs/

api是你的代碼目錄也就是你使用注釋的文件目錄，它會(huì)自動(dòng)掃描使用注解的文件。docs文件時(shí)你要生成api文檔的目錄，也是github page最后要使用的目錄。

檢查api文檔

在docs目錄下直接打開(kāi)index.html就可以查看最終結(jié)果了。

4. github page github page 是一項(xiàng)免費(fèi)的web服務(wù)，它允許你把你的靜態(tài)頁(yè)面發(fā)布出去共其他用戶(hù)通過(guò)瀏覽器查看。剛才我們生成的文檔內(nèi)容都在我們本地，現(xiàn)在我們需要把它發(fā)布到github上

創(chuàng)建github倉(cāng)庫(kù)

將自己的生成后的戴阿曼上船，就是docs整個(gè)目錄

在倉(cāng)庫(kù)的 setting中開(kāi)啟page服務(wù)

用page提供的url去訪問(wèn)

總結(jié)
ApiDoc提供了更好的api文檔閱讀體驗(yàn)，對(duì)于開(kāi)發(fā)者來(lái)說(shuō)免去了寫(xiě)文檔的麻煩。不過(guò)不足就是不能像swagger那樣提供在線調(diào)試，而且要想描述一個(gè)api需要些很多的注釋。

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/72424.html

相關(guān)文章

  • ApiDoc + github page 使用

    摘要：目前支持的變成語(yǔ)言有，，，等，主流的編成語(yǔ)言都支持。文件時(shí)你要生成文檔的目錄，也是最后要使用的目錄。是一項(xiàng)免費(fèi)的服務(wù)，它允許你把你的靜態(tài)頁(yè)面發(fā)布出去共其他用戶(hù)通過(guò)瀏覽器查看。 你的項(xiàng)目在用什么工具書(shū)寫(xiě)api文檔？今天就來(lái)給大家推薦下ApiDoc 1. ApiDoc是什么？ ApiDoc可以根據(jù)你再代碼里的注釋?zhuān)瑏?lái)生成api描述文檔，這樣就不用你自己去告訴端的小伙伴該怎么調(diào)用你的api了...

    Joonas 評(píng)論0 收藏0

  • ApiDoc + github page 使用

    摘要：目前支持的變成語(yǔ)言有，，，等，主流的編成語(yǔ)言都支持。文件時(shí)你要生成文檔的目錄，也是最后要使用的目錄。是一項(xiàng)免費(fèi)的服務(wù)，它允許你把你的靜態(tài)頁(yè)面發(fā)布出去共其他用戶(hù)通過(guò)瀏覽器查看。 你的項(xiàng)目在用什么工具書(shū)寫(xiě)api文檔？今天就來(lái)給大家推薦下ApiDoc 1. ApiDoc是什么？ ApiDoc可以根據(jù)你再代碼里的注釋?zhuān)瑏?lái)生成api描述文檔，這樣就不用你自己去告訴端的小伙伴該怎么調(diào)用你的api了...

    luodongseu 評(píng)論0 收藏0

  • 開(kāi)源的api文檔管理系統(tǒng)

    摘要：國(guó)外的話國(guó)內(nèi)的國(guó)內(nèi)開(kāi)源的非常好用的一款文檔管理系統(tǒng)，安裝也非常方便，只需將源代碼放到項(xiàng)目目錄下自動(dòng)安裝運(yùn)行即可，不要要注意版本必須大于界面簡(jiǎn)潔功能強(qiáng)大的阿里的接口管理工具，開(kāi)源免費(fèi)，接口自動(dòng)化，數(shù)據(jù)自動(dòng)生成，自動(dòng)化測(cè)試，企業(yè)級(jí)管理。 在項(xiàng)目中，需要協(xié)同開(kāi)發(fā)，所以會(huì)寫(xiě)許多API文檔給其他同事，以前都是寫(xiě)一個(gè)簡(jiǎn)單的TXT文本或Word文檔，口口相傳，這種方式比較老土了，所以，需要有個(gè)api...

    zsirfs 評(píng)論0 收藏0

  • 使用 Flask-Docs 自動(dòng)生成 Api 文檔

    摘要：影響我寫(xiě)文檔的原因可能是代碼和文檔分離，有時(shí)候?qū)懲甏a會(huì)忘記補(bǔ)文檔，而且不能及時(shí)查看，使用可以解決我的問(wèn)題，這個(gè)插件可以根據(jù)代碼注釋生成文檔頁(yè)面，代碼注釋改動(dòng)文檔可以及時(shí)更新，而且支持離線文檔下載。 影響我寫(xiě)文檔的原因可能是代碼和文檔分離，有時(shí)候?qū)懲甏a會(huì)忘記補(bǔ)文檔，而且不能及時(shí)查看，使用 Flask-Docs 可以解決我的問(wèn)題，這個(gè)插件可以根據(jù)代碼注釋生成文檔頁(yè)面，代碼注釋改動(dòng)文檔可...

    鄒強(qiáng) 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<