{"id":13748819,"url":"https://github.com/ScaCap/spring-auto-restdocs","last_synced_at":"2025-05-09T11:31:27.125Z","repository":{"id":37270946,"uuid":"48500629","full_name":"ScaCap/spring-auto-restdocs","owner":"ScaCap","description":"Spring Auto REST Docs is an extension to Spring REST Docs","archived":true,"fork":false,"pushed_at":"2023-12-19T14:18:15.000Z","size":4341,"stargazers_count":311,"open_issues_count":0,"forks_count":86,"subscribers_count":51,"default_branch":"master","last_synced_at":"2024-11-15T05:57:24.047Z","etag":null,"topics":["asciidoc","documentation","dokka","java","kotlin","restdocs","spring-auto-restdocs","spring-boot","spring-rest-docs"],"latest_commit_sha":null,"homepage":"https://scacap.github.io/spring-auto-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/ScaCap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"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":"2015-12-23T16:38:34.000Z","updated_at":"2024-10-21T09:29:12.000Z","dependencies_parsed_at":"2024-08-03T07:12:28.588Z","dependency_job_id":null,"html_url":"https://github.com/ScaCap/spring-auto-restdocs","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Fspring-auto-restdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Fspring-auto-restdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Fspring-auto-restdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Fspring-auto-restdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScaCap","download_url":"https://codeload.github.com/ScaCap/spring-auto-restdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253240350,"owners_count":21876593,"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":["asciidoc","documentation","dokka","java","kotlin","restdocs","spring-auto-restdocs","spring-boot","spring-rest-docs"],"created_at":"2024-08-03T07:00:50.147Z","updated_at":"2025-05-09T11:31:25.291Z","avatar_url":"https://github.com/ScaCap.png","language":"Java","readme":"# End-of-life Notice\n\nThis project is officially end-of-life. Users are welcome to maintain it in a\nfork, but there will be no more Scalable-authored changes published. While Spring\nAuto REST Docs helped us over the years to maintain our API documentation,\nwe decided to move to [OpenAPI] and phased out the usage internally. At Scalable,\n[springdoc-openapi] helps us now to automate the generation of API documentation.\n\n[OpenAPI]: https://www.openapis.org/\n[springdoc-openapi]: https://springdoc.org/\n\n---\n\n# Spring Auto REST Docs\n[![Apache License 2](https://img.shields.io/badge/license-ASF2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt)\n[![Build status](https://github.com/ScaCap/spring-auto-restdocs/actions/workflows/build.yaml/badge.svg)](https://github.com/ScaCap/spring-auto-restdocs/actions/workflows/build.yaml)\n[![Maven Central status](https://img.shields.io/maven-central/v/capital.scalable/spring-auto-restdocs-core.svg)](https://search.maven.org/#search%7Cga%7C1%7Ccapital.scalable%20spring-auto-restdocs)\n\nThe aim of this [Spring REST Docs](https://projects.spring.io/spring-restdocs/)\nextension is to help you write even less - both code and documentation.\nYou still get the same nice documentation as with Spring REST Docs itself.\nThe main benefit is that writing less and moving the documentation closer\nto the code increases the maintainability of the documentation.\n\nIn Spring REST Docs you have to add the documentation for your JSON with\na DSL in your test. We moved this documentation to the POJO that represents\nyour JSON object. You just add Javadoc to the fields and it will end\nup in the documentation.\n\nLearn more in the [Introducing Spring Auto REST Docs](https://dzone.com/articles/introducing-spring-auto-rest-docs) article.\nThe [slides](https://www.slideshare.net/fbenz/introducing-spring-auto-rest-docs)\nand the\n[video recording](https://www.youtube.com/watch?v=M7GEN6Jh6CQ)\nfrom the Introducing Spring Auto REST Docs talk at Spring IO 2017 are also available.\n\n## Documentation\n\n[Current 2.0.11 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v2.0.11/docs/index.html) reference guide (based on Spring REST Docs 2.x).\n\n[Legacy 1.0.15 release](https://htmlpreview.github.io/?https://github.com/ScaCap/spring-auto-restdocs/blob/v1.0.15/docs/index.html) reference guide (based on Spring REST Docs 1.x).\n\nLatest master [2.0.12-SNAPSHOT](https://scacap.github.io/spring-auto-restdocs) reference guide.\n\n## Main features\n\n* Automatic documentation of\n[request](https://scacap.github.io/spring-auto-restdocs/#snippets-request-fields) and\n[response](https://scacap.github.io/spring-auto-restdocs/#snippets-response-fields) fields,\n[path](https://scacap.github.io/spring-auto-restdocs/#snippets-path-parameters),\n[query parameters](https://scacap.github.io/spring-auto-restdocs/#snippets-request-parameters) and\n[request headers](https://scacap.github.io/spring-auto-restdocs/#snippets-request-headers)\nusing Jackson and Javadoc/KDoc\n* Automatic documentation of field and parameter\n[optionality](https://scacap.github.io/spring-auto-restdocs/#constraints-optionality) and\n[constraints](https://scacap.github.io/spring-auto-restdocs/#constraints) using JSR 303 annotations\n* Automatic documentation of [entire endpoint](https://scacap.github.io/spring-auto-restdocs/#snippets-section) with [customizations](https://scacap.github.io/spring-auto-restdocs/#snippets-section-customization)\n* A helper to document [authentication](https://scacap.github.io/spring-auto-restdocs/#snippets-authorization)\n* Support for [paging](https://scacap.github.io/spring-auto-restdocs/#paging)\n* Convenient [preprocessors](https://scacap.github.io/spring-auto-restdocs/#preprocessors)\n\n## Usage\n\nSee the [Getting started](https://scacap.github.io/spring-auto-restdocs/#gettingstarted) section in the documentation.\n\n## Sample projects\n\n* [Java WebMVC](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webmvc): Spring Boot 2.3, WebMVC, JUnit 4, Java 8/11/14, Maven/Gradle\n* [Java WebFlux](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/java-webflux): Spring Boot 2.3, WebFlux, JUnit 4, Java 8/11/14, Maven\n* [Kotlin WebMVC](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/kotlin-webmvc): Spring Boot 2.3, WebMVC, JUnit 5, Kotlin 1.4, Maven/Gradle\n\nAll sample projects use [shared POJOs](https://github.com/ScaCap/spring-auto-restdocs/tree/master/samples/shared)\nto demonstarte the usage across projects.\n\n## Building from source\n\nSee the [Building from source](https://scacap.github.io/spring-auto-restdocs/#contributing-building) section in the documentation.\n\n## Contributing\n\n- Submit a Pull Request for any enhancement you made.\n- Create an issue describing your particular problem.\n- Ask and answer questions on Stack Overflow using the [spring-auto-restdocs](https://stackoverflow.com/tags/spring-auto-restdocs) tag.\n\n## License\n\nSpring Auto REST Docs is Open Source software released under the\n[Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html).\n","funding_links":[],"categories":["Libraries"],"sub_categories":["Documentation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScaCap%2Fspring-auto-restdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FScaCap%2Fspring-auto-restdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScaCap%2Fspring-auto-restdocs/lists"}