Documenting RESTful APIs with Spring REST Docs and RAML

This repository is the basis for a talk introducing restdocs-raml - a project that adds RAML support for Spring Rest Docs.

See also https://2018.springio.net/sessions/documenting-restful-apis-with-spring-rest-docs-and-raml

The talk shows why and how to use it.

There is also a recording from the Spring IO 2018 in Barcelona -

Presentation

https://gitpitch.com/mduesterhoeft/spring-restdocs-raml-talk

Branches

The master branch contains the initial state of the sample application.

The restdocs-documented branch contains the project documented with Spring REST Docs.

The restdocs-raml-documented branch contains the project documented with Spring REST Docs and restdocs-raml.

Running the application

git checkout restdocs-raml-documented
./gradlew bootRun