You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,11 +68,13 @@ This is why we came up with this project.
68
68
69
69
### Project structure
70
70
71
-
The project consists of two components:
71
+
The project consists of the following main components:
72
72
73
73
-[restdocs-api-spec](restdocs-api-spec) - contains the actual Spring REST Docs extension.
74
74
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.
75
75
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`.
76
78
-[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.
2. add the dependency to `restdocs-api-spec-gradle-plugin`
126
128
3. apply `restdocs-api-spec-gradle-plugin`
127
129
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`.
129
131
6. add configuration options for restdocs-api-spec-gradle-plugin`. See [Gradle plugin configuration](#gradle-plugin-configuration)
130
132
131
133
See the [build.gradle](samples/restdocs-api-spec-sample/build.gradle) for the setup used in the sample project.
0 commit comments