spring-projects/spring-restdocs
Test-driven documentation for RESTful services observed · 2026-08-28
Health v2 · maintenance only
85/100
- Activity 87
- Release rhythm 75
- Longevity 100
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-09-02. Adoption (stars, forks) is never an input.
- gap_med: 78.0
- age_days: 4347
- days_rel: 85
- days_push: 83
- n_releases_24m: 7
Adoption not part of the score
1182 stars · 730 forks observed · 2026-08-28
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded
Spring REST Docs is a Java library that generates accurate documentation for RESTful APIs by combining hand-written Asciidoctor content with auto-generated snippets produced during tests using Spring MVC Test. It produces readable, test-verified user-guide-style documentation rather than dense auto-generated API specs like Swagger.
Use cases
- document rest api endpoints from tests
- generate api documentation with spring boot
- produce accurate restful service docs
- generate openapi spec from spring tests
- avoid stale swagger documentation
- document request and response payloads in junit tests
When to choose
- you want documentation that is guaranteed accurate because it is generated from passing tests
- you prefer concise, hand-crafted guides over fully automated dense API references
- your stack is Spring Boot or Spring MVC with JUnit or TestNG tests
When to avoid
- you want zero-effort, fully automatic API docs from code annotations alone
- your services are not on the JVM or not testable with Spring MVC Test
- you need interactive API explorer UIs like Swagger UI out of the box
Facets
library · maturity active
testing api-documentation documentation documentation testing apis web-development developer-tools jvm cli rest-api asciidoctor spring spring-mvc-test api-docs test-driven-documentation openapi
7 sources
- readme: https://github.com/spring-projects/spring-restdocs · fetched 2026-08-28 · 188861685686
- homepage: https://spring.io/projects/spring-restdocs · fetched 2026-08-29 · 1e2a101b77d3
- site_page: https://spring.io/quickstart · fetched 2026-08-29 · fc64dd950363
- site_page: https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle · fetched 2026-08-29 · bd6a812a3a95
- site_page: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html · fetched 2026-08-29 · a2ebaede3a78
- site_page: https://enterprise.spring.io · fetched 2026-08-29 · 85ac7d6d5114
- site_page: https://enterprise.spring.io/lts-releases · fetched 2026-08-29 · 3251cc8760b6
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| spring-projects/spring-restdocs | main | 85 |
For agents
markdown · JSON · MCP: product_card(name="spring-projects/spring-restdocs")
Data as of 2026-08-30T08:39:29.467469+00:00 · Report a problem