建站
咨詢
售后
建站咨詢
新聞中心
本篇內(nèi)容主要講解“如何使用gitbook來編寫Api文檔”，感興趣的朋友不妨來看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來帶大家學(xué)習(xí)“如何使用gitbook來編寫Api文檔”吧!
成都創(chuàng)新互聯(lián)公司主要從事成都做網(wǎng)站、網(wǎng)站建設(shè)、網(wǎng)頁(yè)設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)新泰,10年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):13518219792
Gitbook的使用
當(dāng)你使用Gitbook的時(shí)候，新建一個(gè)項(xiàng)目的時(shí)候，會(huì)彈出下面選項(xiàng)，共四種類型的模板提供給你選擇，實(shí)際上他們沒什么區(qū)別，只是一個(gè)Markdown模板：
我們選擇了第一項(xiàng)，當(dāng)然，初次嘗試的朋友，可以都選擇看一看不同的Markdown模板。
如圖所示， Gitbook Editor，實(shí)際上就是一個(gè)特殊的Markdown編輯器。我創(chuàng)建了一個(gè)test項(xiàng)目作為示例，你也可以自己創(chuàng)建一本新書，然后打開源目錄，會(huì)看到如下文件：
SUMMARY.md 這個(gè)文件就是書的目錄結(jié)構(gòu)。Gitbook Editor對(duì)中文支持不太好，有時(shí)候你用Editor創(chuàng)建了一個(gè)章節(jié)，用中文命名，但是當(dāng)你點(diǎn)擊那個(gè)新建的章節(jié)的時(shí)候，會(huì)報(bào)錯(cuò)，解決辦法就是用你自己的編輯器打開這個(gè)文件，直接編輯這個(gè)文件就好了。
具體Editor如何上手，就不詳細(xì)說了，相信你會(huì)用Markdown編輯器就會(huì)用Editor。
當(dāng)你創(chuàng)建了一本書之后，可以通過「Book->Publish As...」功能來把你的書發(fā)布到Gitbook，但是前提是你必須要在Gitbook網(wǎng)站上面也相應(yīng)創(chuàng)建好這本書。
你也可以通過使用Gitbook的幫助，使用Git來創(chuàng)建并上傳你的書：
touch README.md SUMMARY.md
git init
git add README.md SUMMARY.md
git commit -m "first commit"
git remote add gitbook https://push.gitbook.io/blackanger/test.git
git push -u gitbook master
…or push an existing repository from the command linegit remote add gitbook https://push.gitbook.io/blackanger/test.git
git push -u gitbook master
你也可以在本地使用Editor的Preview Website功能，在本地_books目錄中生成靜態(tài)網(wǎng)頁(yè)，也就是書的Web版本。 早先的Gitbook Editor版本可以直接在本地生成epub、pdf、mobi格式的文件，但是最新版本把這些功能去掉了。
使用Gitbook寫你自己的Api文檔
Gitbook寫自己的書很方便，本人前段時(shí)間也發(fā)布了一本免費(fèi)書籍《Chef之道》。其實(shí)你用Gitbook不只是可以寫書，也可以來寫Api文檔，我一直用Gitbook寫Api文檔，我總結(jié)了幾個(gè)優(yōu)點(diǎn)：
Gitbook可以免費(fèi)創(chuàng)建私有庫(kù)，保密性比較高。
類似于Github，有版本控制。就是一個(gè)電子書版的Github。
Gitbook Editor是一個(gè)很好用的Markdown編輯器，有很多貼心的快捷鍵讓你發(fā)掘，比如cmd+shift+d，如果你用習(xí)慣Atom、Sublime、Textmate之類的編輯器，會(huì)很喜歡這些特性。當(dāng)然此類快捷鍵也不是很多，但是相信以后Editor功能會(huì)更加豐富，因?yàn)槲覄偛耪f的這個(gè)特性應(yīng)該也是新加的。起碼比Logdown這個(gè)Markdown編輯器好用多了。
一次編寫，多處使用。接下來我們重點(diǎn)說這個(gè)，也就是我今天重點(diǎn)要說的。
一次編寫，多處使用。
現(xiàn)在是移動(dòng)互聯(lián)網(wǎng)時(shí)代，很多App已經(jīng)開發(fā)在維護(hù)，還有很多很多的App待開發(fā)，而且HTML5、js mvc框架的發(fā)展，有很多人都在維護(hù)Api接口。那么寫一個(gè)可維護(hù)、可讀性高、帶版本控制、可隨心所欲分發(fā)的接口文檔是多么重要。
可讀性/ 可維護(hù) / 版本控制
Gitbook是用Markdown寫的，還支持語法高亮等，用它寫出來的文檔，那看起來是相當(dāng)愉悅的，看下圖示例。
Gitbook正是天生帶版本控制，你可以選擇任意一個(gè)你發(fā)布過的版本。
可隨心所欲分發(fā)
文檔寫好以后，你可以把Gitbook源目錄下面的所有文件都復(fù)制到你項(xiàng)目下(app_root/docs/api/gitbook_api_dir)。這樣，你的項(xiàng)目就多了一份漂亮的文檔，開發(fā)人員還可以在本地打開Web Preview生成在_book目錄下的靜態(tài)網(wǎng)頁(yè)愉悅的看你的Api接口文檔。 如果覺得復(fù)制太土了，你可以直接把Gitbook Editor的Api文檔目錄創(chuàng)建在項(xiàng)目中。
后臺(tái)接口項(xiàng)目、Android App項(xiàng)目、iOS App項(xiàng)目都可以分發(fā)一份，大家可以使用Gitbook Editor來協(xié)同管理接口。
上傳到Github，也可以在線修改閱讀你的文檔，因?yàn)镚ithub也支持Markdown。
是不是非常方便？
到此，相信大家對(duì)“如何使用gitbook來編寫Api文檔”有了更深的了解，不妨來實(shí)際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！
分享名稱：如何使用gitbook來編寫Api文檔
文章地址：http://fisionsoft.com.cn/article/gsojce.html
