📌

Nuxt.jsでWebアプリケーション開発メモ10

に公開
Django
Swagger
OpenAPI
DRF
Claude
tech

概要

バックエンドのREST API仕様をブラウザで確認できるようにする。（Nuxt.js関係なくなっちゃった。)

プロンプト10

# 命令10
DjangoのREST APIの仕様をブラウザで見れるようにして。

Claude Codeからの選択肢提示

● DjangoのREST APIの仕様をブラウザで見るツールは Django REST framework の Browsable API か、drf-spectacular (OpenAPI/Swagger) です。

  - Browsable API: DRFに標準で付属、/api/ エンドポイントをブラウザで直接確認可能
  - drf-spectacular: OpenAPI 3.0形式でAPI仕様を生成、Swagger UIで表示

  どちらを設定したいですか？

drf-spectacularを選択。

対応内容

settings.py

  • 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',を追加。
  • SPECTACULAR_SETTINGSの設定追加。

urls.py

  • 各画面等へのurlルーティングを追加。

画面

Swagger UI

Swagger UI

ReDoc

ReDoc

ソースコード差分

https://github.com/tkure/prototype-backend/commit/77e6bbe35b87ae66ec033744c9a85b0f4de434d6

→ Nuxt.jsでWebアプリケーション開発メモ11

Discussion