richhollis / swagger-docs

Generates swagger-ui json files for Rails APIs with a simple DSL.
MIT License
750 stars 150 forks source link

DRY Documentation and Nested Routes #152

Open josh1703658784 opened 8 years ago

josh1703658784 commented 8 years ago

I have some routes for show like so:

  1. /foo/{foo_id}/bar/{id}.json
  2. /foo/{id}.json

I'm trying to DRY up my documentation.

Can I somehow specify path variables (especially when nested) while also DRYing up my documentation? For example, for the two paths above, could I have a single show documented in a base class that would handle both (and other similar) cases?