Python 서버 프로그래밍: django-rest-swagger를 사용한 API 문서

인터넷이 발전하면서 웹 애플리케이션과 API가 점점 일반화되고 있습니다. Python은 웹 애플리케이션과 API를 구축하는 데 사용할 수 있는 널리 사용되는 프로그래밍 언어입니다. Python에서 Django는 웹 개발을 단순화하는 모델, 보기 및 템플릿을 포함하여 많은 유용한 기능을 제공하는 강력한 웹 프레임워크입니다. 반면, API 문서화는 개발자가 API의 기능과 사용법을 이해하는 데 도움이 되는 중요한 작업입니다. 이 글에서는 django-rest-swagger를 사용하여 API를 문서화하는 방법을 소개합니다.

1. django-rest-swagger 설치

먼저 django-rest-swagger를 설치해야 합니다. pip를 사용하여 설치할 수 있습니다:

pip install django-rest-swagger

2. Integrate 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가 문서 데이터를 Swagger UI에서 렌더링할 수 있도록 coreapi 형식으로 반환하게 됩니다.

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!