django api generator
v1.0.18
App -generatorによって積極的にサポートされている最小限の労力でDRFの上に安全なAPIを生成するシンプルなツール。
機能の完全なセットと長期的なサポートについては、次のような強力なスターターであるDynamic Djangoをご覧ください。
特徴
DRFが提供するAPI engineJWT Tokensによって保護されている(変異リクエスト)Minimal Configuration (各モデルの構成の単一行)Handles any modelCRUDアクセスロジック:READは公開されています(すべてのアイテム、IDでアイテムを取得)Mutating requests JWT Tokensによって保護されています
ステップ#1-
Install the package
$ pip install django-api-generator
// OR
$ pip install git+https://github.com/app-generator/django-api-generator.gitステップ#2-
Update Configuration、新しいアプリを含めます
INSTALLED_APPS = [
'django_api_gen' , # Django API GENERATOR # <-- NEW
'rest_framework' , # Include DRF # <-- NEW
'rest_framework.authtoken' , # Include DRF Auth # <-- NEW
]ステップ#3-
core/settings.pyセクション)でRegister the model
このサンプルコードは、 app1が存在し、モデルBookが定義され、移行されることを前提としています。
API_GENERATOR = {
# pattern:
# API_SLUG -> Import_PATH
'books' : "app1.models.Book" ,
}
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES' : [
'rest_framework.authentication.SessionAuthentication' ,
'rest_framework.authentication.TokenAuthentication' ,
],
}ステップ#4-
Migrate DB、DRFが使用するテーブルを作成します
$ python manage.py makemigrations
$ python manage.py migrateステップ#5-
Generate API
$ python manage.py generate-api
// OR
$ python manage.py generate-api -f # supress confirmation (forcing mode)コードは、プロジェクトのルートのapiフォルダーの下に生成されます。各反復で、 APIコードが上書きされます。
ステップ#6-
Update routing、APIを含めます
from django . contrib import admin
from django . urls import path , include # <-- UPD: 'include` directive
from rest_framework . authtoken . views import obtain_auth_token # <-- NEW
urlpatterns = [
path ( "admin/" , admin . site . urls ),
path ( "api/" , include ( "api.urls" )), # <-- NEW
path ( 'login/jwt/' , view = obtain_auth_token ), # <-- NEW
] ステップ#7 -
Use API
管理されたモデルがBooksの場合、APIインターフェイスは/api/books/およびすべてのCRUDメソッドが利用可能です。
注:要求を変えるために、
JWT Tokenhttp://localhost:8000/login/jwt/route(ユーザーが存在するはずです)によって提供されます。

AppSeedが提供するより多くの開発ツールEmailとDiscord介してサポートを求めてくださいDjango APIジェネレーター - App-Generatorが提供するオープンソースライブラリ