{"id":14972929,"url":"https://github.com/spring-projects/spring-restdocs","last_synced_at":"2025-11-19T15:02:02.136Z","repository":{"id":21620002,"uuid":"24940450","full_name":"spring-projects/spring-restdocs","owner":"spring-projects","description":"Test-driven documentation for RESTful services","archived":false,"fork":false,"pushed_at":"2025-02-03T10:01:56.000Z","size":5854,"stargazers_count":1175,"open_issues_count":49,"forks_count":738,"subscribers_count":91,"default_branch":"main","last_synced_at":"2025-04-23T20:59:55.640Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://spring.io/projects/spring-restdocs","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spring-projects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-10-08T12:53:51.000Z","updated_at":"2025-04-16T05:31:15.000Z","dependencies_parsed_at":"2024-03-28T15:52:17.892Z","dependency_job_id":"11ea1233-94f3-4187-8f21-c1bad990a9ab","html_url":"https://github.com/spring-projects/spring-restdocs","commit_stats":{"total_commits":968,"total_committers":84,"mean_commits":"11.523809523809524","dds":"0.43181818181818177","last_synced_commit":"0abc76307e3a4bdcab376ba068a8122f7b39b328"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-restdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-restdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-restdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-restdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spring-projects","download_url":"https://codeload.github.com/spring-projects/spring-restdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250514767,"owners_count":21443208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:47:46.688Z","updated_at":"2025-11-19T15:02:02.021Z","avatar_url":"https://github.com/spring-projects.png","language":"Java","readme":"# Spring REST Docs [![Build status][1]][2] [![Revved up by Develocity][23]][24]\n\n## Overview\n\nThe primary goal of this project is to make it easy to document RESTful services by combining content that's been hand-written using [Asciidoctor][3] with auto-generated examples produced with the [Spring MVC Test][4] framework.\nThe result is intended to be an easy-to-read user guide, akin to [GitHub's API documentation][5] for example, rather than the fully automated, dense API documentation produced by tools like [Swagger][6].\n\nFor a broader introduction see the Documenting RESTful APIs presentation.\nBoth the [slides][7] and a [video recording][8] are available.\n\n## Learning more\n\nTo learn more about Spring REST Docs, please consult the [reference documentation][9].\n\n## Building from source\n\nYou will need Java 17 or later to build Spring REST Docs.\nIt is built using [Gradle][10]:\n\n```\n./gradlew build\n```\n\n## Contributing\n\nContributors to this project agree to uphold its [code of conduct][11].\n\nThere are several that you can contribute to Spring REST Docs:\n\n - Open a [pull request][12]. Please see the [contributor guidelines][13] for details\n - Ask and answer questions on Stack Overflow using the [`spring-restdocs`][15] tag\n\n## Third-party extensions\n\n| Name | Description |\n| ---- | ----------- |\n| [restdocs-wiremock][16] | Auto-generate WireMock stubs as part of documenting your RESTful API |\n| [restdocsext-jersey][17] | Enables Spring REST Docs to be used with [Jersey's test framework][18] |\n| [spring-auto-restdocs][19] | Uses introspection and Javadoc to automatically document request and response parameters |\n| [restdocs-api-spec][20] | A Spring REST Docs extension that adds API specification support. It currently supports [OpenAPI 2][21] and [OpenAPI 3][22] |\n\n## Licence\n\nSpring REST Docs is open source software released under the [Apache 2.0 license][14].\n\n[1]: https://github.com/spring-projects/spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml/badge.svg?branch=main (Build status)\n[2]: https://github.com/spring-projects/spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml\n[3]: https://asciidoctor.org\n[4]: https://docs.spring.io/spring-framework/docs/4.1.x/spring-framework-reference/htmlsingle/#spring-mvc-test-framework\n[5]: https://developer.github.com/v3/\n[6]: https://swagger.io\n[7]: https://speakerdeck.com/ankinson/documenting-restful-apis-webinar\n[8]: https://www.youtube.com/watch?v=knH5ihPNiUs\u0026feature=youtu.be\n[9]: https://docs.spring.io/spring-restdocs/docs/\n[10]: https://gradle.org\n[11]: CODE_OF_CONDUCT.md\n[12]: https://help.github.com/articles/using-pull-requests/\n[13]: CONTRIBUTING.md\n[14]: https://www.apache.org/licenses/LICENSE-2.0.html\n[15]: https://stackoverflow.com/tags/spring-restdocs\n[16]: https://github.com/ePages-de/restdocs-wiremock\n[17]: https://github.com/RESTDocsEXT/restdocsext-jersey\n[18]: https://jersey.java.net/documentation/latest/test-framework.html\n[19]: https://github.com/ScaCap/spring-auto-restdocs\n[20]: https://github.com/ePages-de/restdocs-api-spec\n[21]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n[22]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md\n[23]: https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle\u0026labelColor=02303A\n[24]: https://ge.spring.io/scans?search.rootProjectNames=spring-restdocs\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-restdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspring-projects%2Fspring-restdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-restdocs/lists"}