基本事項

Side note

Sanic ExtensionsのOpenAPI実装は、sanic-openapi (opens new window)のOAS3実装がベースになっています。実際、Sanic Extensionsはそのプロジェクトの後継であり、Sanic Extensionsのリリースと同時にメンテナンスモードに入りました。もしあなたが以前 OAS3 を sanic-openapi で使っていたなら、Sanic Extensions にアップグレードするのは簡単なはずです。残念ながら、このプロジェクトは OAS2 仕様をサポートしていません。

Sanic Extensionsは、v3.0 OpenAPI仕様 (opens new window)を用いて自動生成されたAPIドキュメントをそのまま提供します。必要なのは、Sanic Extensionsをインスタンス化することによって、アプリケーションを拡張することだけです。

from sanic import Sanic
from sanic_ext import Extend
app = Sanic("MyApp")
Extend(app)

これで、既存のアプリケーションに基づいた美しいドキュメントがすでに生成されていることになります:

http://localhost:8000/docs (opens new window)

Redoc (opens new window)を使う

もしくはSwagger UI (opens new window)