我們如何記錄API，或者如何記錄一個REST API，
我們可以使用軟體或HTML網站維護檔案，甚至可以通過代碼中的某些工具生成檔案，這種方法的缺點是我們需要手動（或通過半自動程序）對檔案進行維護，盡管它是人類可讀的，但實際上不是機器可讀的，
另一種方法是使用WADL，它可以由一些工具生成，在這種情況下，它是機器可讀的，但絕對不是人類可讀的，另外，手動撰寫WADL也是一個乏味的程序，
Eolinker為兩者尋找一個更簡單的解決方案，Eolinker是用于描述REST API的格式的一組規則（換句話說，一種規范），該格式是機器可讀和人類可讀的，因此，它可以用于在產品經理，測驗人員和開發人員之間共享檔案，但也可以被各種工具用來自動化與API相關的流程，
當我們說REST時，我們不一定要遵循RESTful規則，我們參考REST API背后的基本概念，雖然WADL以復雜性為代價涵蓋了幾乎所有可能的API設計，但Eolinker的目標是涵蓋更常見的設計模式，同時簡化撰寫和使用，使其更易于編輯，
為了幫助您了解Eolinker的外觀，請看以下示例：
在上面的示例中，我們描述了一個簡單的用戶登錄API，它具有URL、請求引數等資訊，還描述了成功的回應，如果“用戶”包含無效字符，則會收到一般性400錯誤， 您還可以看到，在整個操作程序中，我們提供了其他檔案，
差不多就是這樣-簡單地說就是Eolinker，Eolinker規范可供所有人閱讀，網址為http://www.Eolinker.com(https://datayi.cn/w/QPDLMwJP)
或閱讀此Eolinker教程，它包含有關如何定義路徑，引數，回應，模型，安全性等的資訊，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/263688.html
標籤：其他