richhollis / swagger-docs

Generates swagger-ui json files for Rails APIs with a simple DSL.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DRY Documentation and Nested Routes

josh1703658784 opened this issue · comments

commented

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?