近幾年前端爆炸式的成長，前後端分離的架構也越來越常見，如果前端和後端的開發者不是同一個人的時候，怎麽樣讓並行開發可以變得容易就非常的重用。

很長遇到一個問題是，前端開發者和後端開發者在API的内容以及格式有落差導致兩邊不好並行開發。

接下來的幾篇文章將要介紹Apiary這個工具，透過這個工具可以讓兩邊溝通沒有落差，並且可以同時進行開發。

這篇先從爲什麽選擇Apiary做開始，市面那麽多種，爲什麽要選Apiary，和其他方案比起來有什麽好處。

先從前後端開發問題看起，以及爲什麽Apiary (API Blueprint)是最適合的解決方案。

前後端分離開發遇到的問題，以及可能解決的方法

前後端分離不用説是最近開發比較常見的一種架構，由後端提供API服務讓前端去呼叫然後呈現内容。

這種框架的好壞不再這個系列的探討範圍，但是這種開發方式有一個很大的問題是：在開發過程中，怎麽確保前端和後端所知道的API定義都一樣？

這個問題可能有幾種處理方式：

1. 前端和後端不同時開發
2. 先定義好文件，前端和後端同時開發
3. 用一些工具例如postman或者json server建立出mock server

不過這集中處理方式多多少少都有一些缺點，也因此了有這系列介紹apiary的文章。

在進入正題之前，先看看這些處理方式有什麽問題。

總結下來，上述各有優略，但是每一個工具想要解決的是：

1. 前後端沒有統一格式，就沒辦法同時開發
2. 文件沒有定義好的撰寫格式 - 每個人撰寫方式可能有點不同，怎麽確保大家寫出來的格式一樣
3. 只有文件沒有mock server，還是要等後端好了才有辦法驗證前端是否沒寫好
4. mock server撰寫方式不一致 - 沒辦法用自己習慣的方式撰寫mock server，有些會太過依賴某個工具

以上這些問題其實很常見，因此世界上已經有聰明人想出了解決方法，同大多數解決方法一樣，不止一種解決方案。

解決方案：從統一格式看起

文件化API是一第一步，有了文件化的API之後，就可以透過工具產生出Mock Server。

有了Mock Server之後，前後端的開發就可以同步進行，因爲前端可以用Mock Server邊開發邊驗證是否攥寫符合文件。

既然知道文件化API是第一步，那麽用一個定義好，開放格式變得非常重要。

目前市面上最廣汎使用的API文件格式有幾種：

1. OpenAPI
2. API Blueprint
3. RAML

如果對每個格式的細節有興趣，請繼續看，不然跳過即可。

以我個人而言，選擇API Blueprint作爲文件撰寫，因爲Markdown大家都會，並且直接看原始也都看得懂。

相較而言，OpenAPI則看起來沒有那麽的直覺，RAML又沒有OpenAPI那麽廣汎，那麽選RAML還不如選OpenAPI。

Apiary是什麽？

上面説了那麽多，終於要進入了正題介紹這個系列的主軸，Apiary。

Apiary本質上是一個Editor+Mock+Test Server的服務，他不止支援API Blueprint，也支援OpenAPI的格式。

撰寫好的文件自動會提供Mock Server可以使用，因此前端可以直接打Mock Server就可以驗證撰寫的是否有問題。

對於後端，有提供Test服務，能夠驗證後端產生的API是否同文件一樣。

免費的版本支援5個人同時編輯一個檔案，因此小團隊共同編輯也沒有什麽問題。

結語

這篇介紹了從最原始的問題，到最後幾種不同解決方案的介紹，以及非常初步介紹Apiary這一個工具。

花了一整個篇幅介紹問題是因爲能夠讓大家理解，爲什麽花時間學習API Blueprint以及Apiary是很值得。

下一篇([apiary][02]設計API時好用的工具 - 讓前後端溝通格式不再卡卡 - 工具使用介紹篇)先從Apiary的基本使用介紹開始。