{"id":15211214,"url":"https://github.com/claudio-pereira-tech/spring-creating_api_documentation_with_restdocs","last_synced_at":"2026-02-24T01:11:30.995Z","repository":{"id":253744860,"uuid":"844387568","full_name":"claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs","owner":"claudio-pereira-tech","description":"Spring - Creating API Documentation with Restdocs","archived":false,"fork":false,"pushed_at":"2024-08-25T08:15:22.000Z","size":311,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T15:06:06.094Z","etag":null,"topics":["documentation","spring","spring-boot","spring-mvc"],"latest_commit_sha":null,"homepage":"https://spring.io/guides/gs/testing-restdocs","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/claudio-pereira-tech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2024-08-19T06:44:00.000Z","updated_at":"2024-08-25T08:15:25.000Z","dependencies_parsed_at":"2025-02-14T16:41:51.773Z","dependency_job_id":null,"html_url":"https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs","commit_stats":null,"previous_names":["claudio-pereira-tech/spring-creating_api_documentation_with_restdocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claudio-pereira-tech%2FSpring-Creating_API_Documentation_with_Restdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claudio-pereira-tech%2FSpring-Creating_API_Documentation_with_Restdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claudio-pereira-tech%2FSpring-Creating_API_Documentation_with_Restdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claudio-pereira-tech%2FSpring-Creating_API_Documentation_with_Restdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/claudio-pereira-tech","download_url":"https://codeload.github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claudio-pereira-tech%2FSpring-Creating_API_Documentation_with_Restdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281264943,"owners_count":26471343,"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","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","spring","spring-boot","spring-mvc"],"created_at":"2024-09-28T08:21:10.339Z","updated_at":"2025-10-27T12:07:16.679Z","avatar_url":"https://github.com/claudio-pereira-tech.png","language":"Java","funding_links":["https://www.buymeacoffee.com/PereiraTech"],"categories":[],"sub_categories":[],"readme":"\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n# Creating API Documentation with Restdocs\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Forks][forks-shield]][forks-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n![Screenshot](https://raw.githubusercontent.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/main/images/screenshot.png)\n\n## About The Project\n\nThis application was developed following the guide [Creating API Documentation with Restdocs][gettingstarted-url]. The guide outlines building a simple RESTful API using [Spring Boot][springboot-url] and [Spring Framework][springframework-url], testing the endpoint, and setting up [Spring REST Docs][springrestdocs-url] to generate API documentation automatically through unit tests. The final result is a robust application that not only functions as intended but also features clear, up-to-date API documentation.\n\nFor this project, [Gradle][gradle-url] was selected as the build system and dependency manager, and [Kotlin][kotlin-url] as the build script language.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Built With\n\n* [![Java][java-shield]][java-url]\n* [![SpringBoot][springboot-shield]][springboot-url]\n* [![SpringFramework][springframework-shield]][springframework-url]\n* [![Gradle][gradle-shield]][gradle-url]\n* [![Docker][docker-shield]][docker-url]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Getting Started\n\nThese instructions will guide setting up a local copy of the project and deploying the application using [Docker Compose][dockercompose-url] for demonstration purposes. Although these instructions are based on Linux distribution, the application can also be run on other operating systems with Docker Compose or Gradle, with the necessary adjustments not covered in this guide.\n\n### Prerequisites\n\nRequirements for downloading the project and deploying the application:\n\n* [git][git-url] - version 2.14.1 or above\n* [Docker Compose][dockercompose-url] - version V2\n* Acknowledgment of Linux Fundamentals\n\n### Downloading the project\n\n```console\ngit clone https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs.git\ncd Spring-Creating_API_Documentation_with_Restdocs/docker\n```\n\n### Deploying the application\n\n```console\ndocker compose up --detach\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Usage\n\nTo explore this project, access the API documentation available at http://localhost or consume the API endpoint at http://localhost/api.\n\n### Accessing the API documentation\n\nTo access the API documentation, open http://localhost in the preferred web browser.\n\n### Consuming the API endpoint\n\nTo consume the API endpoint, use a preferred API testing tool (e.g., [Postman][postman-url], [Insomnia][insomnia-url], [curl][curl-url], [httpie][httpie-url]) to perform a GET request to http://localhost/api.\n\n#### Requesting with curl\n\n```console\ncurl 'http://localhost/api/' -i -X GET\n```\n\n#### Requesting with httpie\n\n```console\nhttp GET 'http://localhost/api/'\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Terminate\n\nAfter finishing all demonstrations, terminate the deployment and remove the built image.\n\n### Terminating the deployment and removing the built image \n\n```console\ndocker compose down --rmi local\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## License\n\nDistributed under the MIT License. See [LICENSE.md][license-url] for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Contact\n\nCláudio de Oliveira Pereira - claudio@pereira.tech - [LinkedIn][linkedin-url]\n\nProject Link: [https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs][project-url]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Support\n\nIf value has been found in this project and it has been helpful in any way, support would be greatly appreciated.\n\n\u003ca href=\"https://www.buymeacoffee.com/PereiraTech\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" \u003e\u003c/a\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- Badges --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs?style=for-the-badge\n[contributors-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/graphs/contributors/\n\n[stars-shield]: https://img.shields.io/github/stars/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs?style=for-the-badge\n[stars-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/stargazers/\n\n[forks-shield]: https://img.shields.io/github/forks/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs?style=for-the-badge\n[forks-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/network/members/\n\n[issues-shield]: https://img.shields.io/github/issues/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs?style=for-the-badge\n[issues-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/issues/\n\n[license-shield]: https://img.shields.io/github/license/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs?style=for-the-badge\n[license-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/blob/main/LICENSE.md\n\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/claudio-oliveira-pereira/\n\n[springboot-shield]: https://img.shields.io/badge/Spring_Boot-3.3.2-white?style=for-the-badge\u0026logo=springboot\u0026logoColor=white\u0026logoSize=auto\u0026labelColor=6DB33F\u0026color=grey\n[springboot-url]: https://spring.io/projects/spring-boot/\n\n[springframework-shield]: https://img.shields.io/badge/Spring_Framework-6.1.12-white?style=for-the-badge\u0026logo=spring\u0026logoColor=white\u0026logoSize=auto\u0026labelColor=6DB33F\u0026color=grey\n[springframework-url]: https://spring.io/projects/spring-framework/\n\n[gradle-shield]: https://img.shields.io/badge/Gradle-02303A?style=for-the-badge\u0026logo=gradle\u0026logoColor=white\u0026logoSize=auto\n[gradle-url]: https://gradle.org/\n\n[java-shield]: https://img.shields.io/badge/Liberica_JDK-22.0.2-white?style=for-the-badge\u0026logo=openjdk\u0026logoColor=black\u0026logoSize=auto\u0026labelColor=5BD5EF\u0026color=grey\n[java-url]: https://bell-sw.com/libericajdk/\n\n[docker-shield]: https://img.shields.io/badge/Docker-2496ED?style=for-the-badge\u0026logo=docker\u0026logoColor=white\u0026logoSize=auto\n[docker-url]: https://www.docker.com/\n\n\u003c!-- Links --\u003e\n[gettingstarted-url]: https://spring.io/guides/gs/testing-restdocs/\n[springrestdocs-url]: https://spring.io/projects/spring-restdocs/\n[kotlin-url]: https://kotlinlang.org/\n[dockercompose-url]: https://docs.docker.com/compose/\n[git-url]: https://git-scm.com/\n[postman-url]: https://www.postman.com/\n[insomnia-url]: https://insomnia.rest/\n[curl-url]: https://curl.se/\n[httpie-url]: https://httpie.io/\n[project-url]: https://github.com/claudio-pereira-tech/Spring-Creating_API_Documentation_with_Restdocs/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaudio-pereira-tech%2Fspring-creating_api_documentation_with_restdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclaudio-pereira-tech%2Fspring-creating_api_documentation_with_restdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaudio-pereira-tech%2Fspring-creating_api_documentation_with_restdocs/lists"}