spring-restdocs
Test-driven documentation for RESTful services
APACHE-2.0 License
Stars
1.2K
Committers
76
Bot releases are hidden (Show)
🐞 Bug Fixes
- UnsupportedOperationException when modifying request and response headers with Framework 6.0.9 and later #906
📔 Documentation
- Clarify the role of snippetsDir as a task input and output #893
🔨 Dependency Upgrades
- Upgrade to Spring Framework 6.0.14 #904
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v2.0.8.RELEASE
Published by spring-builds 11 months ago
spring-restdocs
- v2.0.7.RELEASE
Published by spring-builds almost 2 years ago
🐞 Bug Fixes
- Problem documenting response with custom status code with WebTestClient #847
- modifyUris may corrupt the request or response body if it contains a URI without a port and a colon later in the content #790
📔 Documentation
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v3.0.0-RC1
Published by spring-builds about 2 years ago
⭐ New Features
- Use spring-web's HttpStatusCode to model a response's status #848
- Remove support for preprocessing a request to modify its parameters #846
- Provide separate snippets for documenting query parameters and form parameters #832
📔 Documentation
- Update reference documentation to link to Spring Framework 6's reference documentation #853
- Remove samples in favor of those now in spring-projects/spring-restdocs-samples #852
🔨 Dependency Upgrades
- Upgrade to Jackson 2.13.4.20221013 #862
- Upgrade to JUnit 4.13.2 #863
- Upgrade to REST Assured 5.2.0 #855
- Upgrade to Spring Framework 6.0.0-RC1 #854
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v3.0.0-M4
Published by spring-builds over 2 years ago
⭐ New Features
- Provide a bom that manages the version of all of Spring REST Docs' modules #831
- Remove redundant throws declarations #829
- Specify the language in body snippets based on the request or response's content type #797
- Add support for documenting request and response cookies #592
📔 Documentation
- Section heading for Working With Asciidoctor is missing from the reference documentation #833
- Update documentation examples to use new modifyHeaders preprocessor #827
- Use HTTPS for REST Assured links #824
🔨 Dependency Upgrades
- Upgrade to AsciidoctorJ 2.5.4 #835
- Upgrade to JMustache 1.15 #834
- Upgrade to REST Assured 5.1.1 #836
- Upgrade to Spring Framework 6.0.0-M5 #822
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v3.0.0-M3
Published by spring-builds over 2 years ago
⭐ New Features
- Provide a preprocessor that can modify request and response headers #584
🔨 Dependency Upgrades
- Upgrade samples to H2 2.1.210 #803
- Upgrade samples to Spring Data 2022.0.0-M4 #795
- Upgrade samples to Spring HATEOAS 2.0.0-M3 #798
- Upgrade Slate sample to Slate 2.13.0 #807
- Upgrade to Hibernate 5.6.9.Final #806
- Upgrade to Hibernate Validator 7.0.4.Final #804
- Upgrade to Jackson 2.13.3 #802
- Upgrade to REST Assured 5.0.0 #791
- Upgrade to REST Assured 5.0.1 #805
- Upgrade to Spring Framework 6.0.0-M4 #794
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v3.0.0-M1
Published by spring-builds almost 3 years ago
⭐ New Features
- Remove deprecated code #781
- Drop support for REST Assured until it supports Jakarta EE 9 #761
- Raise the minimum supported version of REST Assured to 4.4 #752
- Raise the minimum supported version of AsciidoctorJ to 2.5 #751
- Raise the minimum supported version of Bean Validation to 3.0 #750
- Raise the minimum supported version of Java to 17 #749
- Raise the minimum supported version of Spring Framework to 6.0 #748
📔 Documentation
- Improve documentation styling and provide a dynamic table of contents #773
- For consistency with other projects, publish reference documentation to a directory named htmlsingle rather than html5 #681
🔨 Dependency Upgrades
- Upgrade samples to Spring Data REST 2022.0.0-M1 #777
- Upgrade samples to Spring HATEOAS 2.0.0-M1 #778
- Upgrade to Jackson 2.13.1 #774
- Upgrade to Spring Framework 6.0.0-M2 #775
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v2.0.6.RELEASE
Published by spring-builds almost 3 years ago
🐞 Bug Fixes
- HTTPie snippet uses --form for multipart requests when --multipart is a clearer alternative #771
- RestDocumentationRequestBuilders' methods for multipart file uploads are not aligned with MockMvc's MockMvcRequestBuilders #770
- HTTP request snippet for a PUT request with a query string duplicates the string's parameters in a form URL encoded body #763
- spring-restdocs-restassured has a transitive dependency on javax.xml.bind:jaxb-api rather than jakarta.xml.bind:jakarta.xml.bind-api #758
- spring-restdocs-restassured has a transitive dependency on commons-logging:commons-logging #757
- Duplicate parts in generated snippets for multipart requests documented with MockMvc #746
- Unhelpful IndexOutOfBoundException when an empty array subsection is extracted #732
- Pretty printing truncates non-json responses that happen to begin with valid json #730
- Diagnostics are poor when a wildcard is used with beneathPath and the identified field doesn't exist everywhere in the payload #715
- Jackson parsing fails when using an UTF-8 character for link masking #705
- Request parts not found when using Spring Framework 5.3 without nio-multipart-parser #703
- Warnings logged by the operation block macro lack context #699
📔 Documentation
- Document how to use REST Docs with the new org.asciidoctor.jvm.convert Gradle plugin #744
- Update Gradle examples to use configurations for dependencies that are Gradle 7-compatible #743
- Document how to build samples in CONTRIBUTING.md #725
- Upgrade the samples to Spring Boot 2.4 #723
- Update Docs to Show Use of Consumer in WebTestClient.Builder #713
- "included in the package" cross-reference is broken #700
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v2.0.5.RELEASE
Published by wilkinsona about 4 years ago
🐞 Bug Fixes
- Operation macro corrupts snippets with UTF-8 characters #696
- Default operation content encoding is unstable as it relies on the underlying OS's default #689
- Request parameters ignored for HTTP DELETE #683
- Changes made by ParametersModifyingOperationPreprocessor are not reflected in a GET request's query string #682
- ignoreUndocumentedParamters is lost when using and() on PathParametersSnippet and RequestParametersSnippet #676
- {method-name} with uppercase word generates dashes #658
- NPE in HttpResponseSnippet when documenting a response with a custom HTTP status #653
- Section title out of sequence with operation macro when using leveloffset #649
- Valueless query parameters are duplicated in request snippets #647
- Snippet templates that contain UTF-8 characters are corrupted on platforms with a non-UTF-8 default encoding #585
📔 Documentation
- Upgrade Slate sample to Slate 2.7.1 #693
- Fix minor typo in Documenting your API #690
- Fix typo in description of how to obtain an instance of RestDocumentationResultHandler #679
- Some cross-references in the samples do not work #674
- Data REST sample cannot resolve spring-restdocs-asciidoctor snapshots #673
- REST Assured JUnit 5 example should use
@BeforeEachrather than@Before#663 - Mention spring-restdocs-webtestclient as an alternative dependency in getting started documentation #654
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
spring-restdocs
- v2.0.4.RELEASE
Published by wilkinsona about 5 years ago
⭐ New Features
- Allow custom snippets directory via JUnit 5 #633
🪲 Bug Fixes
- Responses with custom HTTP statuses cannot be documented #639
- Section title out of sequence warnings may be generated when using operation macro #628
- Operation block macro fails with 2.2 Asciidoctor Gradle Plugins does to missing gradle-projectdir attribute #624
- Diagnostics are poor when misconfiguration leads to operation-specific configuration being null #583
- spring-restdocs-asciidoctor is incompatible with AsciidoctorJ 1.6 and later #581
- Regression in beneathPath in 2.0.3 #573
- Diagnostics are poor when an attempt is made to extract a non-existent subsection of a payload #568
- Optionality of ancestor fields is not considered when resolving the type of a field #567
📔 Documentation
- Invalid part errors when rendering samples' getting-started-guide.adoc #641
- Drop the Grails 3.x sample as it is incompatible with Spring Framework 5 #637
- Fix IDs of sections in examples #629
- Upgrade Asciidoctor Maven Plugin so that syntax highlighting can be enabled using an attribute #620
- Remove remnants of a merge conflict from README #614
- Fix links to ignored() in RequestDocumentation's javadoc #595
- NoSuchBeanDefinitionException when configuring test that uses WebTestClient as described in the user guide #582
- Fix typo in REST Assured HTTP headers example #579
- Improve style and consistency of the documentation #575
🔨 Dependency Upgrades
❤️ Contributors
We'd like to thank all the contributors who worked on this release!
Package Rankings
Top 4.26% on Repo1.maven.org
Badges
Extracted from project README
