2 How API design and documentation work

API設(shè)計(jì)的一般的思路是，API提供者根據(jù)某種語(yǔ)法規(guī)范，表達(dá)和編寫相應(yīng)的API， 然后使用對(duì)應(yīng)這種語(yǔ)法規(guī)范的工具解析并生成指定格式的API文檔， 當(dāng)然， 更進(jìn)一步， API的實(shí)現(xiàn)代碼也可以一并生成。

生成的文檔以及代碼可以發(fā)布到版本控制系統(tǒng)以及相應(yīng)的web站點(diǎn)， 然后API的使用者或者說(shuō)消費(fèi)者根據(jù)發(fā)布的API文檔作為參考， 使用指定的API規(guī)范訪問開放的API服務(wù)。

或者引用一下apiary的流程：

思路上稍微存在一些差異（即是否生成代碼），但先從API設(shè)計(jì)入手，然后迭代，最終發(fā)布這樣的大體流程是類似的。

當(dāng)然， 圍繞著這個(gè)典型的流程， 很多解決方案可以進(jìn)一步提供一些周邊的工具支持， 比如便于測(cè)試的工具， 便于版本化管理的支持， 圖形化的API編輯工具， 對(duì)應(yīng)的客戶端API服務(wù)調(diào)用代碼的生成工具， 等等。