创建API文档页面 :新建了 status/templates/status/api_docs.html 模板文件,包含:
- API认证方式说明
- 所有API端点的详细说明(POST /api/checkin/、GET /api/services/、GET /api/services/{id}/history/、GET /api/status-summary/)
- 每个端点的请求体和响应体示例
- 状态码和检测类型的说明
12 lines
506 B
Python
12 lines
506 B
Python
from django.urls import path
|
|
from . import api_views
|
|
|
|
urlpatterns = [
|
|
# 客户端上报接口
|
|
path('checkin/', api_views.CheckInAPIView.as_view(), name='api-checkin'),
|
|
|
|
# 查询接口
|
|
path('services/', api_views.ServiceListAPIView.as_view(), name='api-service-list'),
|
|
path('services/<int:service_id>/history/', api_views.ServiceHistoryAPIView.as_view(), name='api-service-history'),
|
|
path('status-summary/', api_views.StatusSummaryAPIView.as_view(), name='api-status-summary'),
|
|
] |