python - 如何在 DRF Docs 中描述查询参数?
问题描述
我正在使用 Django REST Framework v3.9 内置交互式文档。
我有一个 url 需要查询参数来获取。例如:
../jobs/?order_choice=0&city=1®ion=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,
}
我想知道如何正确记录它。
解决方案
试试下面的东西......
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
}
"""
推荐阅读
- vba - 无论如何用公共变量填充用户表单文本框?
- javafx - TornadoFX/JavaFX 树视图在变异多个 ObservableList 后无法正确重新填充
- javascript - 尝试使用 puppeteer 单击 iframe 中的按钮
- mongodb - 来自 Kafka 的 MongoSource 连接创建奇怪的 _data 键
- php - 如何在 PHP 中将 unicode 字符串编码为像这样的“\xd1\x81”序列?
- python-sphinx - Sphinx - 在代码块片段中使用省略号 (...)
- javascript - 从由具有相同开头和结尾的元素(标签)组成的字符串构建数组
- powershell - 使用带有 Power Shell 脚本的文件系统的 Visual Studio 发布/部署
- javascript - 如何修复在 Spring Boot 中使用 ajax 调用发送 jsp 页面?
- java - 如何忽略 Spring JPQL 中的空参数?