search

assem-ch / django-swagger-ui

Django swagger UI is a viewer for Swagger YAML files as html.
BSD 3-Clause "New" or "Revised" License
26 stars 9 forks source link

[Feature] Specify Mutliple Swagger YAMLS #2

Open stripathi669 opened 5 years ago

stripathi669 commented 5 years ago

In the case documentaiton gets too big for one YAML file, we need to be able to split doc into multiple files

How can we achieve that?

assem-ch commented 5 years ago

@stripathi669 are you using the $ref:

paths:
  /clients:
    $ref: clients.yaml#/~1clients
  /users:
    $ref: users.yaml#/~1users
stripathi669 commented 5 years ago

@assem-ch Thank you for your reply. I haven't tried it yet. Will try asap and get back

stripathi669 commented 5 years ago

@assem-ch Thank you for your comment. I gave it a spin. Here is my feedback:

  1. The splitting is by path and references. that means that each path has a separate file.
  2. What I was looking for is - just separate file for each tag. To exemplify with a pseudo-code:
paths:
     # ref file 1
     # ref file 2

Maybe the same thing is possible another way?