Python django rest招摇过市:如何对端点进行分组?
我正在使用Django REST框架和Django REST swagger库构建API端点。我想按自定义属性而不是URL对一些API URL进行分组 例如,我有API端点,并希望按函数对它们进行分组:Python django rest招摇过市:如何对端点进行分组?,python,django,rest,django-rest-framework,swagger,Python,Django,Rest,Django Rest Framework,Swagger,我正在使用Django REST框架和Django REST swagger库构建API端点。我想按自定义属性而不是URL对一些API URL进行分组 例如,我有API端点,并希望按函数对它们进行分组: # task list management GET /api/tasks/known - get known tasks list with their parameters GET /api/tasks - get last tasks list with their statuses
# task list management
GET /api/tasks/known - get known tasks list with their parameters
GET /api/tasks - get last tasks list with their statuses
# Tasks by ID management
GET /api/task/12345 - get task result/status
DELETE /api/task/12345 - Revoke task
# Task by name management:
# MyTask123
GET /api/tasks/MyTask123 - get task info (parameters, etc)
POST /api/tasks/MyTask123 - async start new task
# MySuperShinyTask777
GET /api/tasks/MySuperShinyTask777 - get task info (parameters, etc)
POST /api/tasks/MySuperShinyTask777 - async start new task
# scheduled tasks management
GET /api/tasks/scheduled - get list of scheduled tasks
# manage exact scheduled tasks
POST /api/tasks/scheduled/MyTask123 - schedule new task
GET /api/tasks/scheduled/12345 - get scheduled task details
PUT /api/tasks/scheduled/12345 - change scheduled task
DELETE /api/tasks/scheduled/12345 - delete scheduled task
所以我想给大家展示一下按角色分组的情况。现在,他们只对所有的“/api/”进行了分组,仅此而已
在urls.py
中,我将其包括如下内容:
url(r'^api/', include('api.urls'), name='my-api-root'),
如何为django rest swagger进行自定义分组?您可以在任务应用程序中拥有一个url.py(我假设有),并在/tasks URL中声明它们 每个端点都有一个
url(r'^ tasks/(?P<task_id>\w+)$',
YourTaskView,
name='task'),
但是,看起来你可以使用我看到人们不断访问这个问题并投票表决。这意味着问题是实际的。我可以描述我最近完成类似任务的结果 我根据规范创建了API端点的YAML表示。我还必须在后端保留相同的API端点,这是一个缺点,因为这不是自动生成的文档 我安装了docker,它使用我的YAML规范来表示Swagger页面
按自定义组分隔端点很容易,甚至在两个组中都有一个端点。嗨,你知道怎么做吗?不,我没有。看来你可能需要为这个写你自己的前端。哦,谢谢你的快速回复。
url(r'^api/', include('api.tasks.urls'), name='my-api-root'),