From 9aaf91f814d5b3ee3d9ce7d4120bc7a0b54285a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mathias=20D=C3=BCsterh=C3=B6ft?= Date: Mon, 29 Oct 2018 09:43:54 +0100 Subject: [PATCH] restdocs-openapi renamed to restdocs-api-spec `restdocs-openapi` has been renamed to restdocs-api-spec and will offer support for more API specification formats soon. `restdocs-raml` is no longer actively maintained and is archived. --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 23f67f33..9228c8e3 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,7 @@ There are several that you can contribute to Spring REST Docs: | [restdocs-wiremock][17] | Auto-generate [WireMock][18] stubs as part of documenting your RESTful API | | [restdocsext-jersey][19] | Enables Spring REST Docs to be used with [Jersey's test framework][20] | | [spring-auto-restdocs][21] | Uses introspection and Javadoc to automatically document request and response parameters | -| [restdocs-raml][22] | A Spring REST Docs extension that adds RAML support | -| [restdocs-openapi][23] | A Spring REST Docs extension that adds [OpenAPI 2.0][24] support | +| [restdocs-api-spec][23] | A Spring REST Docs extension that adds API specification support. It currently supports [OpenAPI 2][24] and [OpenAPI 3][25] | ## Licence @@ -68,6 +67,6 @@ Spring REST Docs is open source software released under the [Apache 2.0 license] [19]: https://github.com/RESTDocsEXT/restdocsext-jersey [20]: https://jersey.java.net/documentation/latest/test-framework.html [21]: https://github.com/ScaCap/spring-auto-restdocs -[22]: https://github.com/ePages-de/restdocs-raml -[23]: https://github.com/ePages-de/restdocs-openapi +[23]: https://github.com/ePages-de/restdocs-api-spec [24]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md +[25]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md