[DjangoCongress JP 2022] OAI3を使ったDjango REST frameworkのドキュメント生成とカスタマイズ

#django #python #programming #djangorestframework #openapi

Shirai Hono

OpenAPI 3(OAI3) はAPIの構成を記述するのに有効な仕様であり、ドキュメントとして利用することができます。一方、Django REST framework (DRF)は DjangoでRESTful APIを実装できる便利なフレームワークです。 DRFでOAI3を使いドキュメントを生成したい場合、自動生成やDRFのserializerとの連携について、標準機能だけでは限界があります。 本発表ではDRF標準のドキュメント機能について内部実装を紐解きつつ、表示のカスタマイズ方法を紹介します。簡単にドキュメント化できるサードパーティパッケージについても紹介します。

Date Added: November 19, 2024