DRF Frameworkのドキュメントインターフェイス

0922自己概要

DRF Frameworkのドキュメントインターフェイス

RESTフレームワークは自動的にインターフェイスのドキュメントを生成するために、私たちを助けることができます。

Webページとして提示インタフェースのドキュメント。

インターフェイスのドキュメントの自動生成から継承することができAPIViewビューとそのサブクラス。

A.インストールが異なり

pip install coreapi

II。インタフェースドキュメント・アクセス・パスの設定

全体的な経路におけるインターフェースドキュメントパスを追加します。

ビューに対応する文書ルーティング構成rest_framework.documentation.include_docs_urls、

パラメータtitleタイトルインターフェースドキュメントサイトのため。

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题'))
]

位置記述の定義を説明III。文書

ドキュメント文字列ビュー、ビュークラスを1として使用することができる）のような単一のプロセス、

class BookListView(generics.ListAPIView):
    """
    返回所有图书信息.
    """

2）などの複数のビューを含む方法、文書文字列クラスの観点から、別々に定義された方法は、

class BookListCreateView(generics.ListCreateAPIView):
    """
    get:
    返回所有图书信息.

    post:
    新建图书.
    """

3）設定ビューセットビューの場合、ストリングクラスのドキュメントビューは依然として開くように閉じられて定義され、それは、アクションの名前を区別するために使用される、など

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    """
    list:
    返回图书列表数据

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

    read:
    修改图书的阅读量
    """

IV。アクセスインターフェイスドキュメントのWebページ

注意すべき点が2つあります。

1）表示設定ビューセットは、読み込んだドキュメントインターフェイスサイトと呼ばれる、名を取得します

：2）のパラメータの説明は、次のような、モデルオプションhelp_textにクラスまたはフィールドの配列のクラスで定義される必要があります

class BookInfo(models.Model):
    ...
    bread = models.IntegerField(default=0, verbose_name='阅读量', help_text='阅读量')
    ...

若しくは

class BookReadSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = ('bread', )
        extra_kwargs = {
            'bread': {
                'required': True,
                'help_text': '阅读量'
            }
        }