72 lines
2.3 KiB
HTML
72 lines
2.3 KiB
HTML
---
|
|
# The name of your project
|
|
title: Spring REST Docs
|
|
|
|
badges:
|
|
|
|
# Customize your project's badges. Delete any entries that do not apply.
|
|
custom:
|
|
- name: Source (GitHub)
|
|
url: https://github.com/spring-projects/spring-restdocs
|
|
icon: github
|
|
|
|
- name: Issues (GitHub)
|
|
url: https://github.com/spring-projects/spring-restdocs/issues
|
|
icon: tracking
|
|
|
|
- name: CI (Bamboo)
|
|
url: https://build.spring.io/browse/SRD
|
|
icon: ci
|
|
|
|
- name: StackOverflow
|
|
url: http://stackoverflow.com/questions/tagged/spring-restdocs
|
|
icon: stackoverflow
|
|
|
|
- name: Metrics (SonarQube)
|
|
url: https://sonar.spring.io/dashboard/index/org.springframework.restdocs:spring-restdocs
|
|
icon: metrics
|
|
|
|
---
|
|
<!DOCTYPE HTML>
|
|
<html lang="en-US">
|
|
|
|
{% capture billboard_description %}
|
|
|
|
Document RESTful services by combining hand-written documentation with auto-generated
|
|
snippets produced with Spring MVC Test.
|
|
|
|
{% endcapture %}
|
|
|
|
{% capture main_content %}
|
|
|
|
Spring REST Docs helps you to document RESTful services. It combines hand-written
|
|
documentation written with [Asciidoctor](http://asciidoctor.org/) and auto-generated
|
|
snippets produced with [Spring MVC Test](http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle#spring-mvc-test-framework). This approach frees you from the limitations imposed by tools like
|
|
[Swagger](http://swagger.io/). It helps you to produce documentation that is accurate,
|
|
concise, and well-structured. This documentation then allows your users to get the
|
|
information they need with a minimum of fuss.
|
|
|
|
<span id="quick-start"></span>
|
|
## Quick Start
|
|
|
|
Please refer to the [getting started section](http://docs.spring.io/spring-restdocs/docs/1.0.x/reference/html5/#getting-started)
|
|
of the [reference documentation](http://docs.spring.io/spring-restdocs/docs/1.0.x/reference/html5/)
|
|
to get started.
|
|
|
|
{% include download_widget.md %}
|
|
|
|
{% endcapture %}
|
|
|
|
{% capture related_resources %}
|
|
|
|
### Sample Projects
|
|
|
|
* [Rest Notes, built with Spring HATEOAS](https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-hateoas)
|
|
* [Rest Notes, built with Spring Data REST](https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest)
|
|
|
|
{% endcapture %}
|
|
|
|
|
|
{% include project_page.html %}
|
|
</html>
|