restdocs-raml
restdocs-raml copied to clipboard
ePages-de
Adds RAML support for Spring REST Docs
We should add a maven plugin that does what the `restdocs-raml-gradle-plugin` does at the moment so also maven users could use the project.
Currently we consider the resource path to be unique. If the same resource is documented multiple times we could merge the different response types or at least add the different...
Add support for documenting header values
In spring-rest-docs 2.0.0. [beneathPath](https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-request-response-payloads-subsections) functionality has been added. It is a means to document parts of a payload. We could try to use this to extract the definition of types...
If spring-rest-docs finds a field in a list with multiple types (e.g. once null, once string) it sets the type to `JsonFieldType.VARIES` - Currently we use a `NullSchema` in such...
For RAML 1.0 we can use the RAML type definition instead of json schema. This is more readable and better supported by the available tools