Aggregate RAML fragments for resources that are documented multiple times

ePages-de / restdocs-raml

Adds RAML support for Spring REST Docs

MIT License

27 stars 7 forks source link

Aggregate RAML fragments for resources that are documented multiple times #6

Open mduesterhoeft opened 6 years ago

mduesterhoeft commented 6 years ago

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 examples.

mduesterhoeft commented 6 years ago

RAML 1.0 allows to define multiple examples. We could offer functionality for test methods to just provide an additional example to another documentation

See https://github.com/raml-org/raml-examples/blob/367423e7ee952c9a99fc5e478652a8537b420bb0/others/mobile-order-api/api.raml