Python サーバー プログラミング: django-rest-swagger を使用した API ドキュメント

インターネットの発展に伴い、Web アプリケーションと API はますます一般的になってきています。 Python は、Web アプリケーションや API の構築に使用できる人気のあるプログラミング言語です。 Python では、Django は、Web 開発を簡素化するモデル、ビュー、テンプレートなど、多くの便利な機能を提供する強力な Web フレームワークです。一方、API ドキュメントは、開発者が API の機能と使用法を理解するのに役立つ重要なタスクです。この記事では、django-rest-swagger を使用して API を文書化する方法を紹介します。

1. django-rest-swagger のインストール

まず、django-rest-swagger をインストールする必要があります。 pip を使用してインストールできます:

pip install django-rest-swagger

2. django-rest-swagger の統合

次のコンテンツを Django の settings.py ファイルに追加します:

INSTALLED_APPS = [
    # ...
    'rest_framework',
    'rest_framework_swagger',
]

MIDDLEWARE = [
    # ...
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
]

SWAGGER_SETTINGS = {
    'USE_SESSION_AUTH': False, #关闭session认证
    'APIS_SORTER': 'alpha',
    'JSON_EDITOR': True
}

次に、次の内容を Django の urls.py ファイルに追加します。

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='API Document')
urlpatterns = [
    # ...
    url(r'^docs/', schema_view),
]

上記の構成を完了したら、http://localhost:8000/docs/ にアクセスして API ドキュメント ページを参照してください。

3. swagger の構成

Django の settings.py ファイルを変更し、次の内容を追加します:

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

これにより、API が coreapi 形式でドキュメント データを返すようになります。 , これにより、Swagger UI でのレンダリングが有効になります。

4. API ドキュメントの生成

これで、API ビューの作成を開始できます。 API ドキュメントの生成に使用される必要なメタデータをビューに追加します。例:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions

class HelloWorld(APIView):
    """
    简要描述API的功能
    """
    authentication_classes = [authentication.TokenAuthentication]
    permission_classes = [permissions.IsAuthenticated]

    def get(self, request, format=None):
        """
        获取数据

        所需参数：
        * param1 - 参数1说明
        * param2 - 参数2说明

        返回数据：
        * status - response的状态
        """
        content = {'message': 'Hello, World!'}
        return Response(content)

このビューでは、簡単な説明、パラメータの説明、戻り値の説明などのメタデータが追加されます。これらのメタデータは、django-rest-swagger によって API ドキュメントを生成するために使用されます。

5. API ドキュメントの表示

これで、http://localhost:8000/docs/ にアクセスして API ドキュメントを表示できるようになります。ドキュメント ページには、すべての API ビューのリストが表示され、それぞれに独自のメソッド、パラメーター、戻り命令が含まれています。ページ上で API をテストして、適切に動作しているかどうかを確認することもできます。

概要

django-rest-swagger を使用すると、API を簡単に文書化できるため、開発者は API の使用法と機能を理解できます。この記事では、Django に django-rest-swagger を統合し、API ドキュメントを生成する方法を紹介します。この記事が、読者の Python サーバー プログラミングと API ドキュメント テクノロジの理解を深めるのに役立つことを願っています。

以上がPython サーバー プログラミング: django-rest-swagger を使用した API ドキュメントの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。