Commit Graph

140 Commits

Author SHA1 Message Date
Andy Wilkinson
ba48a7270a Inject ApplicationContext not WebApplicationContext with WebTestClient
Closes gh-582
2019-02-18 10:19:17 +00:00
차지훈
ba08a78710 Fix typo in REST Assured HTTP headers example
See gh-579
2019-02-14 10:07:35 +00:00
Jay Bryant
6a2d30a32e Improve style and consistency of the documentation
Closes gh-575
2019-02-11 15:05:47 +00:00
이동욱
e7c59fdaf6 Configure bootJar task to add documentation to Spring Boot fat jar
Closes gh-521
2018-06-26 09:21:16 +01:00
Andy Wilkinson
e7d2d44a05 Polish "Move UriModifyingOperationPreprocessor to core project"
Closes gh-493
2018-03-28 11:44:50 +01:00
Andy Wilkinson
3e12e808b0 Merge branch '1.2.x' 2018-03-28 10:11:20 +01:00
Andy Wilkinson
baa8e6bb90 Document an example of the operation macro's equivalent Asciidoctor
Closes gh-470
2018-03-28 10:10:10 +01:00
bartolom
9950bdbdf1 Fix typo in fully-qualified name of WebTestClientRestDocumentation
Closes gh-481
2018-02-19 12:40:17 +00:00
Andy Wilkinson
d628badc18 Merge branch '1.2.x' 2018-02-19 12:38:22 +00:00
bartolom
7e3417e124 Quote cols attribute in Asciidoc table example
Closes gh-482
2018-02-19 12:36:25 +00:00
Andy Wilkinson
712b5fd9f7 Merge branch '1.2.x' 2018-02-05 12:31:26 +00:00
Andy Wilkinson
80bb632849 Warn against the use of org.asciidoctor.convert 1.5.6
Closes gh-438
2018-02-05 12:25:12 +00:00
Andy Wilkinson
11da628066 Upgrade to Spring Framework 5.0.2.RELEASE
Closes gh-458
2017-11-28 07:21:50 +00:00
Andy Wilkinson
22dd1e75a4 Apply default scheme, host, and port to WebTestClient URIs
Closes gh-461
2017-11-20 09:50:49 +00:00
Johnny Lim
5750babc6f Upgrade to org.asciidoctor.convert 1.5.6
Closes gh-459
2017-11-18 16:30:35 +00:00
Andy Wilkinson
6912977b87 Document how to configure URIs when using WebTestClient
Closes gh-455
2017-11-12 17:48:21 +00:00
Roman Zaynetdinov
2dc48590dd Remove unused custom URI configuration documentation example
Closes gh-457
2017-11-12 15:16:15 +00:00
Andy Wilkinson
a17e17b00a Align constraints support with Hibernate Validator 6
Closes gh-454
2017-11-12 12:56:45 +00:00
Andy Wilkinson
ac1d8ec4ac Merge branch '1.2.x' 2017-11-11 18:58:27 +00:00
Michael J. Simons
92b6268da4 Fix name of self rel in reference documentation
Closes gh-449
2017-11-11 18:57:42 +00:00
Andy Wilkinson
1a858a2e1f Build and test against Spring Framework 5.0.1.RELEASE
Closes gh-443
2017-10-30 10:20:25 +00:00
Andy Wilkinson
cfb1fbc85d Add support for using WebFlux's WebTestClient to document an API
Closes gh-384
2017-10-30 09:58:07 +00:00
Andy Wilkinson
eed90c0b9a Polish "Add support for configuring default request and response preprocessors"
Closes gh-424
2017-10-27 12:09:56 +01:00
Filip Hrisafov
4f8b173836 Add support for configuring default request and response preprocessors
See gh-424
2017-10-27 12:09:56 +01:00
Andy Wilkinson
22cf08a9ad Merge branch '1.2.x' 2017-10-27 12:09:46 +01:00
Andy Wilkinson
abe36e3b54 Ensure that section heading appears in reference documentation
Asciidoctor appears to apply two blanks lines beneath a code block
at the end of an included file otherwise the section heading that
opens the following included file will be omitted.

Closes gh-442
2017-10-27 12:08:11 +01:00
Andy Wilkinson
f0c69ade5e Merge branch '1.2.x' 2017-10-23 15:48:32 +01:00
Andy Wilkinson
473e3e1a7b Correct end tag in included source so that it matches opening tag
Closes gh-441
2017-10-23 15:47:42 +01:00
Andy Wilkinson
dfe856815d Correct section IDs so that all sections are uniquely identified
Closes gh-440
2017-10-23 15:46:42 +01:00
Andy Wilkinson
1499eabef3 Merge branch '1.2.x' 2017-06-30 19:57:02 +01:00
Andy Wilkinson
dff9062a32 Fix formatting problems in the documentation
Previously, the included .adoc files did not consistently end with a 
blank line. In certain cases, Asciidoctor requires a blank line before a
new section. As a result, the lack of blank lines meant that some
section headings did not appear correctly.

This commit updates each of the included .adoc files in the
documentation to ensure that each ends with a blank line.
2017-06-30 19:56:56 +01:00
Andy Wilkinson
e6d548407c Merge branch '1.2.x' 2017-06-30 19:56:24 +01:00
ooz
a8d51da4f4 Fix formatting of reference to HeaderDocumentation in the docs
Closes gh-409
2017-06-30 19:56:08 +01:00
Andy Wilkinson
84f8e55101 Update documentation after removal of deprecated REST Assured 2 support
See gh-387 and 6986cb75
2017-05-19 17:36:30 +02:00
Andy Wilkinson
0e6e785fb0 Add support for JUnit 5
This commit adds support for JUnit 5 and its Jupiter programming
model. A new Jupiter Extension implementation,
RestDocumentationExtension, is provided. This extension can be applied
to a test class to allow it to use Spring REST Docs to document a
RESTful API.

Closes gh-296
2017-05-19 17:29:12 +02:00
Andy Wilkinson
6986cb75a8 Remove deprecated code
Closes gh-387
2017-05-19 09:27:06 +02:00
Andy Wilkinson
41d537d06a Raise the minimum supported version of Spring Framework to 5.0
This commit upgrades to Spring Framework 5.0.0.RC1. It also upgrades
the Spring Boot-based samples to use Spring Boot 2.0.0.M1 which
supports Spring Framework 5. Lastly, it upgrades a number of
third-party dependencies to align with Spring Framework 5 and Spring
Boot 2.

Closes gh-386
2017-05-18 16:46:03 +02:00
Andy Wilkinson
a8e1df3fd8 Raise the minimum support version of Java to 8
Closes gh-388
2017-05-18 16:45:27 +02:00
JD
9d4a118993 Add missing quotes around value of snippets attribute
Closes gh-389
2017-04-26 14:47:52 +01:00
Tomasz Kopczynski
30fa6bcc5f Include request body and response body default snippets list
Closes gh-379
2017-04-10 09:32:38 +01:00
Johnny Lim
dd00ce05aa Fix typo in Asciidoctor attributes configuration
Closes gh-377
2017-03-31 11:36:51 +01:00
Andy Wilkinson
ea20363c62 Merge branch '1.1.x' 2017-03-23 12:36:19 +00:00
Andy Wilkinson
b6120cd539 Fix broken cross-reference 2017-03-23 12:33:09 +00:00
Andy Wilkinson
b1227ce019 Remove recommendation about tweaking Surefire's configuration
Configuring Surefire to run tests found in files ending in
Documentation.java has the unwanted side-effect of switching off its
defaults, i.e. you end up with your documentation tests being run and
nothing else. While using a specific name for your documentation tests
can make them easier to identify, it isn't required. The documentation
also doesn't explicitly recommend using a Documentation suffix.

This commit simplifies things by removing the configuration that
changes Surefire's default inclusions.

Closes gh-368
2017-03-23 12:19:08 +00:00
Andy Wilkinson
ab1613ed63 Add support for using a wildcard when documenting a payload field
Closes gh-265
2017-03-23 11:05:48 +00:00
Andy Wilkinson
78982cf515 Add support for REST Assured 3
Closes gh-262
2017-03-20 21:39:25 +00:00
Andy Wilkinson
a4d2fc39d8 Allow snippet section titles to be customized using document attributes
Closes gh-363
2017-03-08 10:41:54 +00:00
Andy Wilkinson
826e0a5dec Polish “Provide a block macro for including an operation's snippets”
- Copy snippets used in the tests in @BeforeClass rather than using
   Gradle so that the tests can be run easily in an IDE
 - Address problems in operation_block_macro.rb reported by Rubocop
 - Rename new test class to more closely match the name of the Ruby
   class that it’s testing
 - Gracefully handle a missing operation
 - Align behaviour when an operation or snippet is missing more closely
   with Asciidoctor’s behaviour when an include references a missing
   file
 - Use kebab-case rather than snake_case for new test resources
 - Update the documentation to describe the new macro

See gh-354
Closes gh-323
2017-03-07 17:27:29 +00:00
Andy Wilkinson
e2041333a6 Merge branch '1.1.x' 2016-12-16 14:45:10 +00:00
Gerrit Meier
2fb3ede3a6 Document that port is omitted when it matches the scheme's default
Closes gh-325
Closes gh-329
2016-12-16 14:41:30 +00:00