Skip to content

Commit 0f3b135

Browse files
committed
Readme adoptions
1 parent f8411a7 commit 0f3b135

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,13 @@ This is why we came up with this project.
6868

6969
### Project structure
7070

71-
The project consists of two components:
71+
The project consists of the following main components:
7272

7373
- [restdocs-api-spec](restdocs-api-spec) - contains the actual Spring REST Docs extension.
7474
This is most importantly the [ResourceDocumentation](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ResourceDocumentation.kt) which is the entrypoint to use the extension in your tests.
7575
The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ResourceSnippet.kt) is the snippet used to produce a json file `resource.json` containing all the details about the documented resource.
76+
- [restdocs-api-spec-restassured](restdocs-api-spec-mockmvc) - contains a wrapper for `MockMvcRestDocumentation` for easier migration to `restdocs-api-spec` from MockMvc tests using plain `spring-rest-docs-mockmvc`.
77+
- [restdocs-api-spec-restassured](restdocs-api-spec-restassured) - contains a wrapper for `RestAssuredRestDocumentation` for easier migration to `restdocs-api-spec` from RestAssured tests using plain `spring-rest-docs-restassured`.
7678
- [restdocs-api-spec-gradle-plugin](restdocs-api-spec-gradle-plugin) - adds a gradle plugin that aggregates the `resource.json` files produced by `ResourceSnippet` into an API specification file for the whole project.
7779

7880
### Build configuration
@@ -102,7 +104,7 @@ repositories { //4
102104
103105
dependencies {
104106
//..
105-
testCompile('com.epages:restdocs-api-spec:0.5.0') //5
107+
testCompile('com.epages:restdocs-api-spec-mockmvc:0.5.0') //5
106108
}
107109
108110
openapi { //6
@@ -125,7 +127,7 @@ openapi3 {
125127
2. add the dependency to `restdocs-api-spec-gradle-plugin`
126128
3. apply `restdocs-api-spec-gradle-plugin`
127129
4. add the `jcenter` repository used to resolve the `com.epages:restdocs-api-spec` module of the project.
128-
5. add the actual `restdocs-api-spec` dependency to the test scope
130+
5. add the actual `restdocs-api-spec-mockmvc` dependency to the test scope. Use `restdocs-api-spec-restassured` if you use `RestAssured` instead of `MockMvc`.
129131
6. add configuration options for restdocs-api-spec-gradle-plugin`. See [Gradle plugin configuration](#gradle-plugin-configuration)
130132

131133
See the [build.gradle](samples/restdocs-api-spec-sample/build.gradle) for the setup used in the sample project.

0 commit comments

Comments
 (0)