spring-projects/spring-restdocs

View on GitHub

Test-driven documentation for RESTful services

Stars: 1.2k
Forks: 731
Open beginner issues: 0
Indexed issues: 45

Dominant language: Java
License: Apache-2.0
Last GitHub push: Jun 11, 2026
Latest indexed: Sep 21, 2026
Contributing guide: Contributing guide
Code of conduct: Code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

45 open issues indexed

Support extracting Bean Validation constraints from method parameters Open

status: waiting-for-triage

Difficulty 5/5 Over a week Newbie friendliness 45/100

spring-projects/spring-restdocs#1026 · 2 comments · Opened Mar 7, 2026
Reinstate support for REST Assured now that it supports Groovy 5 Open

status: waiting-for-votes type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#1020 · 6 comments · Opened Dec 13, 2025
Add support for RestTestClient Open

type: enhancement

spring-projects/spring-restdocs#995 · 1 assignee · Opened Oct 1, 2025
Duplicate File Parts Generated in MockMvc using MockPart Open

status: blocked status: waiting-for-triage

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#953 · 7 comments · Opened Jan 6, 2025
Add support for modifying a URI's path during pre-processing Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

spring-projects/spring-restdocs#945 · Opened Oct 7, 2024
Consistency with the subsection path. Open

status: feedback-provided status: waiting-for-triage

Difficulty 3/5 1-2 days Newbie friendliness 45/100

spring-projects/spring-restdocs#937 · 4 comments · Opened Aug 6, 2024
Add support for Bean Validation's constraint groups Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

spring-projects/spring-restdocs#887 · 2 comments · 1 reaction · Opened Apr 15, 2023
Replace factory with builder when creating operation requests/responses Open

status: blocked type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 42/100

spring-projects/spring-restdocs#886 · 1 comment · Opened Apr 9, 2023
Provide an option for a field to be hidden from the documentation while still being validated Open

status: waiting-for-votes type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#747 · 1 comment · Opened Sep 24, 2021
Add ability to document an object root, just like it is possible to document an array Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#745 · 1 comment · Opened Aug 30, 2021
Use exchange rather than operation to refer to a request and response Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#733 · Opened Jun 15, 2021
Add support for resolving Bean Validation's container element constraints Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#717 · Opened Apr 19, 2021
Document how to use Spring REST Docs with the MockMVC Kotlin DSL Open

type: documentation

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

spring-projects/spring-restdocs#677 · 8 comments · 4 reactions · Opened Apr 2, 2020
Provide more control over quotes used in curl and HTTPie request snippets Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 50/100

spring-projects/spring-restdocs#650 · 1 comment · Opened Oct 15, 2019
Field path handling makes no distinction between a.[] and a Open

type: bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#627 · 2 comments · 2 reactions · Opened Jun 21, 2019
When a payload has fields with mixed presence documenting those fields may still result in a failure due to undocumented fields Open

type: bug

Difficulty 3/5 1-2 days Newbie friendliness 42/100

spring-projects/spring-restdocs#626 · Opened Jun 20, 2019
Provide a Gradle plugin that applies REST Docs' configuration conventions Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 30/100

spring-projects/spring-restdocs#625 · 1 comment · 1 reaction · Opened Jun 19, 2019
Improve beneathPath to work with multiple nested arrays Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

spring-projects/spring-restdocs#569 · 2 comments · 2 reactions · Opened Dec 12, 2018
Provide an option to switch off the curl snippet's use of -i Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 48/100

spring-projects/spring-restdocs#552 · 4 comments · Opened Sep 20, 2018
Create Kotlin DSL for Spring RestDocs Open

status: pending-design-work type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#547 · 29 comments · 3 reactions · Opened Aug 28, 2018
Request body is empty when using MockMvc, application/x-www-form-urlencoded and param Open

status: waiting-for-triage

Difficulty 4/5 3-5 days Newbie friendliness 30/100

spring-projects/spring-restdocs#545 · 6 comments · 2 reactions · Opened Aug 23, 2018
Allow the type of an array's scalar elements to be documented and enforced Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#505 · 3 comments · 3 reactions · Opened Apr 24, 2018
Tag regions of Asciidoctor snippets to allow their contents to be selectively included Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 30/100

spring-projects/spring-restdocs#495 · 3 comments · Opened Mar 27, 2018
Support array indices in JSON field paths Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

spring-projects/spring-restdocs#468 · 3 comments · 1 reaction · Opened Dec 15, 2017
Support for Messaging controllers Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#373 · 3 comments · 2 reactions · Opened Mar 26, 2017
Support multiple types on a field descriptor and assert that actual type matches one of them Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

spring-projects/spring-restdocs#352 · 7 comments · Opened Feb 20, 2017
Provide http(s) default port method Open

type: enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

spring-projects/spring-restdocs#347 · 6 comments · Opened Feb 9, 2017
Support for passing custom values/services into Snippet classes Open

status: waiting-for-triage

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#308 · 3 comments · Opened Sep 26, 2016
Produce URI Snippet Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

spring-projects/spring-restdocs#299 · 5 comments · Opened Sep 7, 2016
Add support for documenting a request URI's matrix variables Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 25/100

spring-projects/spring-restdocs#295 · 3 comments · Opened Aug 31, 2016
Provide a snippet for documenting request and response structure Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 38/100

spring-projects/spring-restdocs#277 · 9 comments · 7 reactions · Opened Jul 11, 2016
Investigate if it's possible to document HTTP headers more strictly without it becoming too laborious Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

spring-projects/spring-restdocs#275 · Opened Jul 11, 2016
Add support for replacing binary multipart data with placeholder content Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#264 · 2 comments · Opened Jun 17, 2016
Make it easier to use JSON libraries other than Jackson alongside REST Docs Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 28/100

spring-projects/spring-restdocs#263 · 4 comments · Opened Jun 17, 2016
Allow descriptors to be loaded from a file Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#248 · 6 comments · 1 reaction · Opened May 24, 2016
Allow snippets to be used to assert that there are no fields, parameters, etc Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 30/100

spring-projects/spring-restdocs#241 · Opened May 21, 2016
Native support for Server-Sent Events and Streaming API endpoints Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#219 · 4 comments · 2 reactions · Opened Apr 12, 2016
Provide a fluent API for snippet configuration Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

spring-projects/spring-restdocs#192 · 1 comment · Opened Feb 3, 2016
Make it easier to document a resource with fields and links that come and go as the resource's state changes Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#178 · Opened Dec 11, 2015
Improve HAL link rel matching to consider curie name Open

type: enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

spring-projects/spring-restdocs#176 · Opened Dec 11, 2015
Provide a custom backend or CSS for Asciidoctor specifically designed for API documentation Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 20/100

spring-projects/spring-restdocs#174 · Opened Dec 1, 2015
Improve support for documenting payloads with multiple sets of links Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 25/100

spring-projects/spring-restdocs#164 · 1 comment · 1 reaction · Opened Nov 14, 2015
Provide support for more sophisticated path-based constraint description resolution Open

type: enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

spring-projects/spring-restdocs#106 · 2 comments · 6 reactions · Opened Aug 25, 2015
Supporting postman collections Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#47 · 10 comments · 5 reactions · Opened Mar 30, 2015
Provide support for automatic documentation of request and response structure using JSON schema Open

type: enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

spring-projects/spring-restdocs#43 · 3 comments · 6 reactions · Opened Mar 24, 2015

spring-projects/spring-restdocs

Get new issues in your inbox