Несколько документации API в одном файле Swagger

Question

Можно ли иметь несколько (каким-то образом разделенных) REST API-документов, но только в одном файле swamger yaml?

Или swamger yaml может содержать только одну документацию по API?

Потому что у меня есть 2 REST API, разработанных мной, и я хочу иметь общий пользовательский интерфейс вместо двух, которыми я мог бы управлять с помощью шлюза, такого как Tyk.

Answer 1

Вы можете сделать это с помощью тегов swagger.io

Например, весной (springfox-swagger) вам нужно просто поместить один и тот же тег в несколько классов API, и он объединит их в одну группу в пользовательском интерфейсе swagger.

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

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

В пользовательском интерфейсе swagger вы увидите только один API (first-api) со всеми методами внутри обоих классов.