如何利用GitHub GraphQL API開(kāi)發(fā)個(gè)人博客荔茬?

作為一個(gè)程序員废膘,搭建一個(gè)個(gè)人博客幾乎是所有人的需求,一來(lái)比較酷慕蔚,二來(lái)也可以記錄自己的學(xué)習(xí)和生活總結(jié)丐黄。但如果你不是全棧工程師,實(shí)現(xiàn)這個(gè)需求還是有點(diǎn)麻煩孔飒。后端搭建一套現(xiàn)有的前端框架及前端寫(xiě)API都還是有一定門(mén)檻的灌闺,當(dāng)然艰争,如果你是大牛當(dāng)我沒(méi)說(shuō),哈哈哈桂对!

下面甩卓,我將介紹一個(gè)特別簡(jiǎn)單的方法,甚至不用寫(xiě)代碼蕉斜,執(zhí)行幾個(gè)命令就可以搭建一個(gè)博客逾柿,就算你不是程序員,也是So easy宅此。那就是:fork我的博客机错。為什么說(shuō)fork我的博客就可以搭建一個(gè)博客呢?博客重要的是有內(nèi)容父腕,并且可以隨時(shí)更新弱匪,而不是一個(gè)靜態(tài)頁(yè)。這就要用到本文的核心:GitHub GraphQL API侣诵,這是github提供的一個(gè)開(kāi)放式的API痢法。我們只需要將文章用Markdown寫(xiě)好后,放到博客項(xiàng)目Issues里面杜顺,然后通過(guò)這個(gè)api财搁,獲取我們的寫(xiě)的文章,再前端渲染躬络,就可以啦<獗肌!是不是特別棒穷当,都不要寫(xiě)API提茁,也不用考慮文章存哪。下面我來(lái)介紹如何實(shí)現(xiàn):

獲取access token

請(qǐng)求GitHub GraphQL API馁菜,首先需要按照以下步驟在github申請(qǐng)一個(gè)access token:

右上角個(gè)人頭像 > Settings > Developer settings > Personal access tokens > Generate new token

然后在Token description 寫(xiě)好關(guān)于這個(gè)token的描述茴扁,在Select scopes選擇相應(yīng)的權(quán)限,這里只需要user > read:user 就可以汪疮,點(diǎn)擊Generate token按鈕后會(huì)跳轉(zhuǎn)到token列表頁(yè)峭火,這時(shí)需要馬上把這個(gè)token記錄下來(lái),因?yàn)檫@是敏感數(shù)據(jù)智嚷,刷新后就沒(méi)有了卖丸,不然得重新申請(qǐng)。

項(xiàng)目搭建

建議大家直接Fork我的項(xiàng)目 simbawus/blog盏道,再修改相應(yīng)配置稍浆,這樣可以免去開(kāi)發(fā)的成本,并且這個(gè)項(xiàng)目會(huì)持續(xù)更新,配置修改及啟動(dòng)可查看我項(xiàng)目的README衅枫。當(dāng)然也可以fork后進(jìn)行二次開(kāi)發(fā)嫁艇。也十分鼓勵(lì)大家從零開(kāi)始開(kāi)發(fā),也順便練練手为鳄。

獲取GraphQL API數(shù)據(jù)

關(guān)于GraphQL的介紹裳仆,可查看我些的這篇文章前端應(yīng)該知道的GraphQL

GitHub GraphQL API的文檔并沒(méi)有使用示例孤钦,如果之前沒(méi)用過(guò)GraphQL API,還是有點(diǎn)懵的纯丸,下面我舉三個(gè)常見(jiàn)的例子說(shuō)明下偏形,具體可以看我博客代碼,別忘了Star噢~觉鼻。

獲取標(biāo)簽及相關(guān)issues

通常俊扭,我們會(huì)在博客首頁(yè)設(shè)計(jì)一個(gè)有分類的文章列表,這就要求在發(fā)布Issue時(shí)需要選擇對(duì)應(yīng)的label坠陈。先看官方label文檔

Connections 里面有issues萨惑,所以在查詢labels的同時(shí),還可以查詢issues仇矾。先列出要傳輸?shù)臄?shù)據(jù)data庸蔼,核心也在這:

data = {
  query: `query {
    repository(owner:"simbawus", name: "blog") {
      issues(orderBy:{field: UPDATED_AT, direction: DESC} , labels: null, first: 10, after: ${page}) {
        edges{
          cursor
          node{
            title
            updatedAt
            bodyText
            number
          }
        }
      }
      labels(first: 100){
        nodes{
          name
        }
      }
    }
  }`
};

repository代表查詢指定的倉(cāng)庫(kù),括號(hào)里的參數(shù)owner代表這個(gè)倉(cāng)庫(kù)的所有者贮匕,name代表倉(cāng)庫(kù)名稱姐仅。issues表示要查詢的issue列表,里面的參數(shù)表示這個(gè)列表的條件:orderBy為排序方式刻盐,根據(jù)更新時(shí)間UPDATED_AT和倒序DESC來(lái)掏膏,labels為null,說(shuō)明查詢的是所有issues敦锌,first表示一次查詢返回的issues數(shù)量馒疹,after傳上一個(gè)issue的id,可用來(lái)分頁(yè)乙墙,最終這次請(qǐng)求拿到的數(shù)據(jù)結(jié)構(gòu)如下颖变,完整的請(qǐng)瀏覽器查看:

{
  "data": {
    "repository": {
      "issues": {
        "edges": {
          "0": {
            "cursor": "Y3Vyc29yOnYyOpK5MjAxOC0wNC0yNlQxMDoyNjoxNiswODowMM4S8hYL",
            "node": {
              "bodyText": "作為一個(gè)程序員...",
              "number": "11",
              "title": "如何利用GitHub GraphQL API開(kāi)發(fā)個(gè)人博客?",
              "updatedAt": "2018-04-22T03:46:34Z",
            }
          }
        }
      },
      "labels": {
        "nodes": {
          "0": {
            "name": "JavaScript"
          }
        }
      }
    }
  }
}

搜索

search這個(gè)connections的文檔寫(xiě)的讓我一臉懵逼伶丐,摸索了好久才寫(xiě)出來(lái)悼做,大家可以試著按官網(wǎng)文檔寫(xiě)一下。

let data = {
  query: `query {
      search(query:"${keyWords} repo:simbawus/blog", type: ISSUE, first: 10) {
        issueCount
        edges{
          cursor
          node{
            ... on Issue {
              title
              number
              bodyText
              updatedAt
            }
          }
        }
      }
    }`
};

search的query參數(shù)類型為String!哗魂,表示一個(gè)非空的字符串肛走,怎么也想不到要這么寫(xiě)才行吧?query:"${keyWords} repo:simbawus/blog"录别。node 這個(gè)fields的文檔朽色,看的也是二臉懵逼邻吞,還好想到es6的擴(kuò)展符。

詳情

最重要的是文章內(nèi)容這部分了葫男,傳輸數(shù)據(jù)比較簡(jiǎn)單:

let data = {
  query: `query {
    repository(owner:"simbawus", name: "blog") {
      issue(number: ${articleId}) {
        title
        updatedAt
        bodyHTML
      }
    }
  }`
};

請(qǐng)求直接返回一段HTML抱冷,問(wèn)題是如何處理這段HTML,格式化并且高亮文章里面的代碼梢褐。這里我用的是React的dangerouslySetInnerHTML和github的css庫(kù)github-markdown-css旺遮,核心代碼如下:

import 'github-markdown-css';
class ArticlePage extends React.Component {
  _renderHTML() {
    return { __html: this.state.bodyHTML };
  }
  render() {
    return ( 
      <div  className = 'markdown-body'
            dangerouslySetInnerHTML = { this._renderHTML() } >
      </div>
    );
  }
}

結(jié)合GitHub GraphQL API開(kāi)發(fā)個(gè)人博客的核心內(nèi)容基本就這么多了,具體代碼歡迎查看github:simbawus/blog盈咳,一起踩坑耿眉。

歡迎討論,點(diǎn)個(gè)贊再走吧~

文章同步于以下社區(qū)鱼响,可以選一個(gè)關(guān)注我噢 ?????

simbawu | github | segmentfault | 知乎 | 簡(jiǎn)書(shū) | 掘金

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末鸣剪,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子丈积,更是在濱河造成了極大的恐慌筐骇,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件江滨,死亡現(xiàn)場(chǎng)離奇詭異铛纬,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)牙寞,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)饺鹃,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人间雀,你說(shuō)我怎么就攤上這事悔详。” “怎么了惹挟?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵茄螃,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我连锯,道長(zhǎng)归苍,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任运怖,我火速辦了婚禮拼弃,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘摇展。我一直安慰自己吻氧,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著盯孙,像睡著了一般鲁森。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上振惰,一...
    開(kāi)封第一講書(shū)人閱讀 51,146評(píng)論 1 297
  • 那天歌溉,我揣著相機(jī)與錄音,去河邊找鬼骑晶。 笑死痛垛,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的透罢。 我是一名探鬼主播榜晦,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼羽圃!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起抖剿,我...
    開(kāi)封第一講書(shū)人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤朽寞,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后斩郎,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體脑融,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年缩宜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了肘迎。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡锻煌,死狀恐怖妓布,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情宋梧,我是刑警寧澤匣沼,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站捂龄,受9級(jí)特大地震影響释涛,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜倦沧,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一唇撬、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧展融,春花似錦窖认、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)轮傍。三九已至,卻和暖如春首装,著一層夾襖步出監(jiān)牢的瞬間创夜,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工仙逻, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留驰吓,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓系奉,卻偏偏與公主長(zhǎng)得像檬贰,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子缺亮,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • Swift版本點(diǎn)擊這里歡迎加入QQ群交流: 594119878最新更新日期:18-09-17 About A cu...
    ylgwhyh閱讀 25,365評(píng)論 7 249
  • 在童年和少年時(shí)代,我一直是一個(gè)靦腆害羞并鸵、乖巧聽(tīng)話鸳粉、猶豫不決的人。 我總是為各種潛在的不測(cè)而擔(dān)憂园担,幾乎不會(huì)嘗試任何大...
    勝虎觀心閱讀 2,668評(píng)論 4 6
  • 窗前一棵玉蘭樹(shù) 年年春來(lái)花開(kāi)早 粉妝玉琢鴉鵲妒 未及妖嬈魂已渺 香消玉殞佳期負(fù) 護(hù)花因恨黃鸝鳥(niǎo) 若得良弓飛羽矢 淺...
    渴死之水閱讀 1,395評(píng)論 60 68
  • 今天上午給義烏二店配了韓池秀特價(jià)內(nèi)褲届谈,還有女士特價(jià)襯衣,趁著外出搞活動(dòng)多賣點(diǎn)弯汰!中街店配了彩棉島特價(jià)睡衣 下午在通乾...
    活在當(dāng)下_02ab閱讀 147評(píng)論 0 0
  • 厲偉是婷煙在這個(gè)大樓里不能說(shuō)唯一也是少數(shù)欣賞的人艰山,一直覺(jué)得他很干凈不管身體還是心靈,總和那群烏合之眾的馬屁精...
    未聞聽(tīng)閱讀 167評(píng)論 0 0