Question

是否可以有多个（以某种方式分开的）REST API文档，但只能包含在一个庞大的Yaml文件中？

或者摇摇欲坠的Yaml只能包含一个API文档吗？

因为我有2个REST API，我想开发一个通用的swagger ui而不是两个，所以我可以使用Tyk这样的网关进行管理。

Answer 1

您可以使用swagger.io tags

例如在spring（springfox-swagger）中，您只需将相同的标签放在多个API类上，它将在swagger UI中将它们合并为一组。

  superset-worker:
    build: *superset-build
    command: ["celery", "worker", "--app=superset.tasks.celery_app:app", "--pool=prefork", "-Ofair", "-c", "4"]
    env_file: docker/.env
    restart: unless-stopped
    depends_on: *superset-depends-on
    volumes: *superset-volumes

  superset-beat:
    build: *superset-build
    user: root
    command: ["celery", "beat", "--app=superset.tasks.celery_app:app", "--pidfile=", "-f", "/app/celery_beat.log"]
    env_file: docker/.env
    restart: unless-stopped
    depends_on: *superset-depends-on
    volumes: *superset-volumes

在不拘一格的用户界面中，您只会看到一个API（first-api），并且两个类中的所有方法都在其中。

一个Swagger文件中的多个API文档

1 个答案: