{"id":16514323,"url":"https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller","last_synced_at":"2026-05-03T21:32:20.691Z","repository":{"id":100623192,"uuid":"169803762","full_name":"ingogriebsch/sample-spring-restdocs-simple-restcontroller","owner":"ingogriebsch","description":"This sample shows you how to implement document a simple REST controller with Spring REST Docs","archived":false,"fork":false,"pushed_at":"2025-07-12T01:41:52.000Z","size":102,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-03T19:36:01.700Z","etag":null,"topics":["example","java","sample","spring","spring-boot","spring-rest-docs","spring-web"],"latest_commit_sha":null,"homepage":"","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/ingogriebsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-02-08T21:52:50.000Z","updated_at":"2020-07-18T12:37:51.000Z","dependencies_parsed_at":"2023-05-16T10:15:29.013Z","dependency_job_id":null,"html_url":"https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ingogriebsch/sample-spring-restdocs-simple-restcontroller","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fsample-spring-restdocs-simple-restcontroller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fsample-spring-restdocs-simple-restcontroller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fsample-spring-restdocs-simple-restcontroller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fsample-spring-restdocs-simple-restcontroller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ingogriebsch","download_url":"https://codeload.github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fsample-spring-restdocs-simple-restcontroller/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32586187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["example","java","sample","spring","spring-boot","spring-rest-docs","spring-web"],"created_at":"2024-10-11T16:12:14.476Z","updated_at":"2026-05-03T21:32:20.676Z","avatar_url":"https://github.com/ingogriebsch.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring REST Docs simple REST controller sample\n[![Build Status](https://travis-ci.org/ingogriebsch/sample-spring-restdocs-simple-restcontroller.svg?branch=master)](https://travis-ci.org/ingogriebsch/sample-spring-restdocs-simple-restcontroller)\n[![Codecov Status](https://codecov.io/gh/ingogriebsch/sample-spring-restdocs-simple-restcontroller/branch/master/graph/badge.svg)](https://codecov.io/gh/ingogriebsch/sample-spring-restdocs-simple-restcontroller)\n[![Codacy Status](https://api.codacy.com/project/badge/Grade/932a7d3670e64310a345db7df8db6305)](https://app.codacy.com/app/ingo.griebsch/sample-spring-restdocs-simple-restcontroller?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=ingogriebsch/sample-spring-restdocs-simple-restcontroller\u0026utm_campaign=Badge_Grade_Dashboard)\n[![DepShield Status](https://depshield.sonatype.org/badges/ingogriebsch/sample-spring-restdocs-simple-restcontroller/depshield.svg)](https://depshield.github.io)\n[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)\n\nThis sample shows you how to document a simple REST controller with Spring REST Docs.\n\nThis service is written using Spring Boot which makes it easy to get it up and running so that you can start exploring the REST API and their documentation.\nAfter you started up the service, this page is available under \u003chttp://localhost:8080\u003e. \nThe documentation explaining the REST API implemented through this service is available under \u003chttp://localhost:8080/docs/index.html\u003e.\n\nIf you want to test the REST API, you can simply use [Postman](https://www.getpostman.com/), [curl](https://curl.haxx.se/) or another HTTP client to execute some requests against this service. \nThe necessary input to successfully execute a request and what you can expect as output is explained through the REST API documentation. \n\nThe service uses Spring REST Docs to document the public REST API. \nThe API is implemented through class [BookController](https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller/blob/master/src/main/java/com/github/ingogriebsch/sample/spring/restdocs/restcontroller/BookController.java).\nClass [BookControllerDoc](https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller/blob/master/src/test/java/com/github/ingogriebsch/sample/spring/restdocs/restcontroller/BookControllerDoc.java) is using the Spring REST Docs framework to implement tests which are generating a set of snippets.\nThese snippets are used as includes to complete the documentation located under [src/main/asciidoc](https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller/tree/master/src/main/asciidoc).\nThe build process defined in the [pom.xml](https://github.com/ingogriebsch/sample-spring-restdocs-simple-restcontroller/blob/master/pom.xml) generates the resulting html files which are then copied into the static content service folder to be available during runtime.  \n\n## Used frameworks\nCollection of the mainly used frameworks in this project. There are more, but they are not that present inside the main use case therefore they are not listed here.\n\n*   [Spring REST Docs](https://docs.spring.io/spring-restdocs/docs/1.2.6.RELEASE/reference/html5/)\n*   [Spring Web](https://docs.spring.io/spring/docs/4.3.12.RELEASE/spring-framework-reference/htmlsingle/#spring-web)\n*   [Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.10.RELEASE/reference/htmlsingle)\n\n## License\nThis code is open source software licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingogriebsch%2Fsample-spring-restdocs-simple-restcontroller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fingogriebsch%2Fsample-spring-restdocs-simple-restcontroller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingogriebsch%2Fsample-spring-restdocs-simple-restcontroller/lists"}