django-rest-swagger:如何分组端点？

Question

我正在使用Django REST Framework和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

# 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进行自定义分组？

Answer 1

我看到人们不断地访问这个问题并对它投赞成票。这意味着这个问题是真实的。我可以描述我最近完成了类似的任务。

我根据OpenAPI规范创建了API端点的YAML表示。我也必须在后端保留相同的API端点，这是一个缺点，因为这不是自动生成的文档。

我用docker安装了昂首阔步，它使用YAML规范来表示Swagger页面。

很容易通过自定义组分离端点，甚至在两个组中有一个端点。

Answer 2

您可以在任务应用程序(我假设有一个)中有一个urls.py，并在/tasks urls中声明它们。

每一个端点都有一个

url(r'^ tasks/(?P<task_id>\w+)$',
    YourTaskView,
    name='task'),

这在api根urls.py中是这样的

url(r'^api/', include('api.tasks.urls'), name='my-api-root'),

但是，看起来你可以用DRF路由器