很高興宣布 Spring REST Docs 1.1.0.RELEASE 的發布，現在可以在 Maven Central、JCenter 和我們的 發布儲存庫 中使用。

重點

REST Assured

除了 Spring Framework 的 MockMvc 提供的輕量級無伺服器文件生成外，您現在可以使用 REST Assured 來測試和記錄您的 RESTful 服務。 這為 JVM 的所有角落及其他地方打開了 Spring REST Docs，讓您可以記錄任何可以透過 HTTP 存取的內容。

範例 現在包括 一個應用程式，該應用程式使用 REST Docs 記錄、使用 Grails 構建並使用 Spock 測試。 使用 REST Docs 記錄使用 Ratpack 實作的 API 的第三方範例也可用。 感謝 Jenn Strater 編寫了這兩個範例。

Markdown

已新增對生成 Markdown 片段的支援。 Markdown 本身不如 Asciidoctor 功能強大，但與現有文件工具鏈（如 Slate）結合使用時，效果非常好。

TestNG

除了現有對使用 JUnit 的支援外，您現在還可以將 Spring REST Docs 與 TestNG 一起使用。

可重複使用的程式碼片段

現在可以使用一些常見的配置建立程式碼片段，然後重複使用。 這減少了在記錄 API 上常見部分（例如 self 連結）時的重複。 感謝 Marcel Overdijk 的回饋和提取請求，這些回饋和提取請求大大改善了這個新功能。

寬鬆的程式碼片段

預設情況下，如果您忽略了某些文件的記錄，或者嘗試記錄不存在的內容，Spring REST Docs 將導致您的測試失敗。 這對於詳細的 API 文件非常有用，但在記錄您想要專注於請求或回應特定部分的場景時，可能會受到限制。 您現在可以使用寬鬆的程式碼片段來記錄連結、請求和回應欄位以及請求和路徑參數，而不必明確忽略您不想記錄的所有內容。

將 Spring REST Docs 1.1 與 Spring Boot 1.3 一起使用

預設情況下，Spring Boot 1.3 使用 Spring REST Docs 1.0。 要使用 1.1，您應該覆寫 Boot 的相依性管理中配置的版本，方法是在您的 pom.xml 或 build.gradle 中進行配置。

pom.xml

<properties>
    <spring-restdocs.version>1.1.0.RELEASE</spring-restdocs.version>
</properties>

build.gradle

ext['spring-restdocs.version']=1.1.0.RELEASE

謝謝

感謝所有為 Spring REST Docs 做出貢獻並幫助塑造 1.1 版的每個人。 期待您在此處、在 GitHub 上、Stack Overflow 和 Twitter 上的回饋。

專案頁面 | GitHub | 問題 | 文件