你造麼？ REST API 文檔還能夠這樣建立！

當一個應用須要對第三方提供服務接口時，
REST API 是目前主流的選擇。
對於 REST API 的開發者來講，
無論 API 的用戶是內部團隊仍是第三方，
高質量的文檔都是不可或缺的。
事實上長久以來，
API 文檔的正確性一直困擾着開發人員。
建立文檔並不難，
難的是如何維護文檔，
讓文檔與代碼的變化保持同步。
Spring REST Doc，
爲建立和維護 REST API 文檔
給出了另一種思路——
手寫文檔和自動生成相結合。

Spring REST Doc的手寫文檔用來提供必要的背景知識和相關介紹，而基於單元測試的自動生成文檔用來產生真實有效的 HTTP 請求和響應相關的內容。因爲自動生成的部分是基於單元測試的，能夠保證文檔的準確性，不然單元測試就會失敗。

今天，咱們就來詳細瞭解 Spring REST Docs，包括基本的配置和對 HTTP 請求和響應的不一樣部分添加文檔。

即刻點擊「閱讀原文」得到完整文章，REST API 文檔的準確性由咱們來守護！