后端API文档.明信片详细设计文档
后端API文档
件包含了关于明信片功能的后端API设计。以下是详细的接口描述和使用说明。
- 接口一：创建明信片
- 请求方式：POST
- 请求参数：
- 标题：明信片的标题（字符串，必填）
- 内容：明信片的具体内容（字符串，必填）
-
返回值：
- 成功：201 Created
- 失败：400 Bad Request
-
接口二：获取明信片详情
- 请求方式：GET
- 请求参数：
- id：明信片的唯一标识（整型，必填）
-
返回值：
- 成功：200 OK
- 失败：404 Not Found
-
接口三：更新明信片
- 请求方式：PUT
- 请求参数：
- id：明信片的唯一标识（整型，必填）
- 标题：新的明信片标题（字符串，可选）
- 内容：新的明信片内容（字符串，可选）
-
返回值：
- 成功：200 OK
- 失败：400 Bad Request
-
接口四：删除明信片
- 请求方式：DELETE
- 请求参数：
- id：明信片的唯一标识（整型，必填）
- 返回值：
- 成功：204 No Content
- 失败：404 Not Found
注意事项：所有接口请求的返回数据将采用JSON格式，错误信息将通过status code进行返回。
文件大小：21.41KB
评论区