Как описать параметры запроса в DRF Docs?

Question

Я использую встроенную интерактивную документацию Django REST Framework v3.9.
У меня есть URL-адрес нужны параметры запроса для получения. такие как: ../jobs/?order_choice=0&city=1&region=0 Но я не знаю, как документировать это в интерактивной документации.

Я использую method: для добавления параметров: такие как:

class JobListView(APIView):
    """
    get:
    - order_choices
    - city
    - region
    - job_type
    """

но печатать в одну строку

- order_choices - city - region - job_type

это мои параметры /

    params_data = {
        'city': request.query_params.get('city', None),
        'region': request.query_params.get('region', None),
        'job_type': request.query_params.get('job_type', None),
        'status': 1,
    }

Я хочу знать, как правильно его документировать.

Answer 1

Попробуйте что-то вроде ниже ...

class PackageViewSet(viewsets.ModelViewSet):
"""
** Query Parameters **

    `page` - get data of a particular page.

    `page_size` - change total objects in a page (default=20).

** Filter Parameters **

    `status` - `1/2`

** Search Parameters **

    `name` - `search by package name`

** Ordering Parameters **

    `name`

    `created_at`

    `updated_at`

** Default Ordering **

    `-created_at`

`Method Allowed`

    `GET -` `Lists all the Packages of a facility/company.`

    `POST -` `Creates Package for a facility.`

    `PUT -` `Updates a Package.`

    `DELETE -` `deletes a Package.`

`POST/Create, PUT/Update`

    {
        "name": "package one",
        "description": "package one",
        "status": 1    // 1- Active, 2-Inactive
    }
"""