syroegkin / swagger-markdown

swagger to markdown transpiler
MIT License
237 stars 87 forks source link

Add support for Tags and Tag Grouping of Paths? #188

Closed kevinawoo closed 1 year ago

kevinawoo commented 2 years ago

Swagger supports grouping paths via tags https://swagger.io/docs/specification/grouping-operations-with-tags/.

This request is to ask for support for add tag groups as markdown header groupings.

An example output would be something like:

# My Awesome API
## Version 2.0
### Security
security stuff...

### Dogs
These endpoints are dog related endpoints.

#### /list
##### Get
###### Summary
Get all available dogs
###### Description
We'll give a list of all the dogs in the world, paged of course

### Cats
These endpoints are cats related endpoints.

#### /list
##### Get
###### Summary
Get all available cats
###### Description
We'll give a list of all the cats in the world, paged of course

This proposed solution would require that:

syroegkin commented 1 year ago

This is indeed a very nice feature. I'll take care of it and it shall be included in the v2.0 release.

syroegkin commented 1 year ago

:tada: This issue has been resolved in version 2.0.0-beta.13 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

syroegkin commented 1 year ago

:tada: This issue has been resolved in version 2.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: