1
- # Spring REST Docs [ ![ Build status] [ 1 ]] [ 2 ] [ ![ Revved up by Develocity] [ 24 ]] [ 25 ]
1
+ # Spring REST Docs [ ![ Build status] [ 1 ]] [ 2 ] [ ![ Revved up by Develocity] [ 23 ]] [ 24 ]
2
2
3
3
## Overview
4
4
@@ -29,23 +29,22 @@ There are several that you can contribute to Spring REST Docs:
29
29
30
30
- Open a [ pull request] [ 12 ] . Please see the [ contributor guidelines] [ 13 ] for details
31
31
- Ask and answer questions on Stack Overflow using the [ ` spring-restdocs ` ] [ 15 ] tag
32
- - Chat with fellow users [ on Gitter] [ 16 ]
33
32
34
33
## Third-party extensions
35
34
36
35
| Name | Description |
37
36
| ---- | ----------- |
38
- | [ restdocs-wiremock] [ 17 ] | Auto-generate WireMock stubs as part of documenting your RESTful API |
39
- | [ restdocsext-jersey] [ 18 ] | Enables Spring REST Docs to be used with [ Jersey's test framework] [ 19 ] |
40
- | [ spring-auto-restdocs] [ 20 ] | Uses introspection and Javadoc to automatically document request and response parameters |
41
- | [ restdocs-api-spec] [ 21 ] | A Spring REST Docs extension that adds API specification support. It currently supports [ OpenAPI 2] [ 22 ] and [ OpenAPI 3] [ 23 ] |
37
+ | [ restdocs-wiremock] [ 16 ] | Auto-generate WireMock stubs as part of documenting your RESTful API |
38
+ | [ restdocsext-jersey] [ 17 ] | Enables Spring REST Docs to be used with [ Jersey's test framework] [ 18 ] |
39
+ | [ spring-auto-restdocs] [ 19 ] | Uses introspection and Javadoc to automatically document request and response parameters |
40
+ | [ restdocs-api-spec] [ 20 ] | A Spring REST Docs extension that adds API specification support. It currently supports [ OpenAPI 2] [ 21 ] and [ OpenAPI 3] [ 22 ] |
42
41
43
42
## Licence
44
43
45
44
Spring REST Docs is open source software released under the [ Apache 2.0 license] [ 14 ] .
46
45
47
- [ 1 ] : https://ci. spring.io/api/v1/teams/ spring-restdocs/pipelines/spring-restdocs-2.0.x/jobs/build/ badge ( Build status )
48
- [ 2 ] : https://ci. spring.io/teams/ spring-restdocs/pipelines/spring-restdocs-2.0.x?groups=build
46
+ [ 1 ] : https://github.com/ spring-projects/ spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml/ badge.svg?branch=main ( Build status )
47
+ [ 2 ] : https://github.com/ spring-projects/ spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml
49
48
[ 3 ] : https://asciidoctor.org
50
49
[ 4 ] : https://docs.spring.io/spring-framework/docs/4.1.x/spring-framework-reference/htmlsingle/#spring-mvc-test-framework
51
50
[ 5 ] : https://developer.github.com/v3/
@@ -59,13 +58,12 @@ Spring REST Docs is open source software released under the [Apache 2.0 license]
59
58
[ 13 ] : CONTRIBUTING.md
60
59
[ 14 ] : https://www.apache.org/licenses/LICENSE-2.0.html
61
60
[ 15 ] : https://stackoverflow.com/tags/spring-restdocs
62
- [ 16 ] : https://gitter.im/spring-projects/spring-restdocs
63
- [ 17 ] : https://github.com/ePages-de/restdocs-wiremock
64
- [ 18 ] : https://github.com/RESTDocsEXT/restdocsext-jersey
65
- [ 19 ] : https://jersey.java.net/documentation/latest/test-framework.html
66
- [ 20 ] : https://github.com/ScaCap/spring-auto-restdocs
67
- [ 21 ] : https://github.com/ePages-de/restdocs-api-spec
68
- [ 22 ] : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
69
- [ 23 ] : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
70
- [ 24 ] : https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A
71
- [ 25 ] : https://ge.spring.io/scans?search.rootProjectNames=spring-restdocs
61
+ [ 16 ] : https://github.com/ePages-de/restdocs-wiremock
62
+ [ 17 ] : https://github.com/RESTDocsEXT/restdocsext-jersey
63
+ [ 18 ] : https://jersey.java.net/documentation/latest/test-framework.html
64
+ [ 19 ] : https://github.com/ScaCap/spring-auto-restdocs
65
+ [ 20 ] : https://github.com/ePages-de/restdocs-api-spec
66
+ [ 21 ] : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
67
+ [ 22 ] : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
68
+ [ 23 ] : https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A
69
+ [ 24 ] : https://ge.spring.io/scans?search.rootProjectNames=spring-restdocs
0 commit comments