Multiple API documentation in one Swagger file

Question

Is it possible to have multiple (somehow separated) REST API documentations but only in one swagger yaml file?

Or can the swagger yaml contain only one API documentation?

Because I have 2 REST API developed by me, and I want to have a common swagger ui instead of two, which I could manage with a gateway like Tyk.

Yes you can have a single Swagger UI for multiple API definitions. See How to organise/build a Swagger UI interface for a directory which contains many Swagger definition .json/.yml files and Swagger UI with Multiple Urls — Helen
– Helen, Commented Jun 28, 2018 at 10:48
Almost, but that answers are talking about index.html changes. But here I don't have index.html file, only the yaml itself. — victorio
– victorio, Commented Jun 28, 2018 at 10:53
Something like this then? Override “host” and “basePath” at the “/{path}” level, What is the significance of servers property in OpenAPI 3.0? — Helen
– Helen, Commented Jun 28, 2018 at 10:56

Nikola Andreev · Accepted Answer · 2020-06-24 13:30:19Z

1

You can do it with swagger.io tags

For example in spring (springfox-swagger) you need just to put the same tag on multiple API classes and it will merge them in one group in the swagger UI.

@Api(value = "First API", tags = {"first-api"})  
public class FirstApi { ... }

@Api(tags = {"first-api"})  
public class SecondApi { ... }

In the swagger UI you will see only one API (first-api) with all the methods inside from both classes.

answered Jun 24, 2020 at 13:30

Nikola Andreev

6345 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Multiple API documentation in one Swagger file

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related