多实例布局

可以按照 Django 的应用布局，设置多个 OpenAPI 实例。

应用1

app1/urls.py [示例1]

from django.urls import include, path

from django_oasis.core import OpenAPI, Resource


@Resource("/api")
class API:
    def get(self): ...


openapi = OpenAPI(title="Document 1")
openapi.add_resource(API)

urlpatterns = [
    path("", include(openapi.urls)),
]

应用2

app2/urls.py [示例1]

from django.urls import include, path

from django_oasis.core import OpenAPI, Resource


@Resource("/api")
class API:
    def get(self): ...


openapi = OpenAPI(title="Document 2")
openapi.add_resource(API)

urlpatterns = [
    path("", include(openapi.urls)),
]

项目 urls.py

urls.py [示例1]

from django.urls import include, path

from django_oasis.docs import swagger_ui

urlpatterns = [
    path("app1/", include("app1.urls")),
    path("app2/", include("app2.urls")),
    path("docs/", swagger_ui()),
]

SwaggerUI [示例1]