欢迎使用我们的 Blog API 服务!以下是我们 API 的详细文档,帮助您了解如何使用我们的服务。
路径
/api/documents
:获取所有文档列表/api/documents/{id}
:获取特定 ID 的文档详情
请求方法
GET
:获取数据POST
:创建新文档PUT
:更新现有文档DELETE
:删除文档
示例
获取所有文档列表
GET /api/documents
响应:
{
"documents": [
{
"id": 1,
"title": "Markdown 基础",
"content": "Markdown 是一种轻量级标记语言,用于格式化文本。"
},
{
"id": 2,
"title": "如何使用 API",
"content": "本文档介绍了如何使用我们的 API 服务。"
}
]
}
获取特定 ID 的文档详情
GET /api/documents/1
响应:
{
"id": 1,
"title": "Markdown 基础",
"content": "Markdown 是一种轻量级标记语言,用于格式化文本。"
}
注意事项
- 请确保您有足够的权限进行操作。
- 所有 API 请求都需要携带正确的认证信息。
更多信息,请参阅我们的官方文档。
API 图标