Django 인터페이스 문서

Django 인터페이스 문서
Django REST Framework 자체 인터페이스 문서
https://www.django-rest-framework.org/community/3.6-announcement/#interactive-api-documentation
django-rest-swagger
swagger 소개
Swagger: 규범적이고 완전한 프레임워크로 RESTful 스타일의 웹 서비스를 생성, 설명, 호출, 시각화하는 데 사용됩니다.전체적인 목표는 클라이언트와 파일 시스템의 소스 코드를 서버로 똑같은 속도로 업데이트하는 것이다.인터페이스가 변동될 때 대응하는 인터페이스 문서도 자동으로 업데이트됩니다.
Swagger가 가장 인기 있는 REST APIs 문서 생성 도구 중 하나가 될 수 있는 이유는 다음과 같습니다.

Swagger는 상호작용적인 API 콘솔을 생성하여 개발자가 API를 신속하게 학습하고 시도할 수 있도록 한다.

Swagger는 클라이언트 SDK 코드를 생성하여 다양한 플랫폼에서 실현할 수 있다.

Swagger 파일은 다양한 플랫폼에서 코드 주석에서 자동으로 생성됩니다.

Swagger는 강력한 지역 사회를 가지고 그 안에 강력한 공헌자가 많다.

1 django-rest-swagger 설치

pip install django-rest-swagger

2 settings에 있습니다.py에서 구성

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

주의: settings.py에서 사용자 정의 swagger 설정 항목은 참고 문헌을 참조한다.
3 urls에 있습니다.py에서 구성

from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPICodec
schema_view = get_schema_view(title='       ', renderer_classes=[SwaggerUIRenderer, OpenAPICodec])

urlpatterns = [
    url(r'swagger/', schema_view, name='swagger'),  # swagger      
]

django-rest-swagger는 두 가지 유용한 렌더링기를 제공합니다: SwaggerUIrendererer와 OpenAPIrenderer.
참조:https://www.jianshu.com/p/dc77f652e7d7 https://blog.csdn.net/sinat_41622641/article/details/81636682 https://www.django-rest-framework.org/api-guide/schemas/#schemagenerator