社区分享API实现 · Pull Request !45 · 可及/surprisemeal

社区分享功能API文档

概述：
本文档提供了关于“惊喜一餐”项目中社区分享功能API的详细说明。这些API允许用户进行社区分享的创建、检索、更新和删除操作。所有API均通过RESTful接口设计，确保了操作的直观性和高效性。

基本信息
（1）项目名称：惊喜一餐
（2）API版本：1.0.0
（3）基础路径：/social-shares

API详细说明

3.1. 创建社区分享（POST请求）
（1）路径：/social-shares
（2）方法：POST
（3）请求体：
json
{
  "userid": 1,
  "content": "这是一条社区分享内容",
  "sharetime": "2024-07-27T14:00:00Z"
}

（4）描述：创建一个新的社区分享记录。
（5）成功响应：

代码：200
内容示例：
json
{
  "success": true,
  "data": {
    "shareid": 1,
    "userid": 1,
    "content": "这是一条社区分享内容",
    "sharetime": "2024-07-27T14:00:00Z"
  },
  "message": "操作成功",
  "code": 200
}

（6）错误响应：

代码：500
内容示例：
json
{
  "success": false,
  "message": "添加社区分享失败",
  "code": 500
}

3.2. 获取所有社区分享（GET请求）
（1）路径：/social-shares
（2）方法：GET
（3）描述：检索系统中所有社区分享的列表。
（4）成功响应：

代码：200
内容示例：
json
{
  "success": true,
  "data": [
    {
      "shareid": 1,
      "userid": 1,
      "content": "这是一条社区分享内容",
      "sharetime": "2024-07-27T14:00:00Z"
    },
    ...
  ],
  "message": "操作成功",
  "code": 200
}

（5）错误响应：

代码：404
内容示例：
json
{
  "success": false,
  "message": "社区分享列表为空",
  "code": 404
}

3.3. 根据ID获取社区分享（GET请求）
（1）路径：/social-shares/{id}
（2）方法：GET
（3）参数：

id：path参数，社区分享的唯一标识符。
（4）描述：根据社区分享ID获取特定社区分享的详细信息。
（5）成功响应：
代码：200
内容示例：
json
{
  "success": true,
  "data": {
    "shareid": 1,
    "userid": 1,
    "content": "这是一条社区分享内容",
    "sharetime": "2024-07-27T14:00:00Z"
  },
  "message": "操作成功",
  "code": 200
}

（6）错误响应：

代码：404
内容示例：
json
{
  "success": false,
  "message": "社区分享不存在",
  "code": 404
}

3.4. 更新社区分享信息（PUT请求）
（1）路径：/social-shares
（2）方法：PUT
（3）请求体：
json
{
  "shareid": 1,
  "userid": 1,
  "content": "更新后的社区分享内容",
  "sharetime": "2024-07-27T14:00:00Z"
}

（4）描述：根据社区分享ID更新社区分享信息。
（5）成功响应：

代码：200
内容示例：
json
{
  "success": true,
  "data": {
    "shareid": 1,
    "userid": 1,
    "content": "更新后的社区分享内容",
    "sharetime": "2024-07-27T14:00:00Z"
  },
  "message": "操作成功",
  "code": 200
}

（6）错误响应：

代码：500
内容示例：
json
{
  "success": false,
  "message": "更新社区分享失败",
  "code": 500
}

3.5. 删除社区分享（DELETE请求）
（1）路径：/social-shares/{id}
（2）方法：DELETE
（3）参数：

id：path参数，社区分享的唯一标识符。
（4）描述：根据社区分享ID删除社区分享。
（5）成功响应：
代码：200
内容示例：
json
{
  "success": true,
  "data": true,
  "message": "操作成功",
  "code": 200
}

（6）错误响应：

代码：500
内容示例：
json
{
  "success": false,
  "message": "删除社区分享失败",
  "code": 500
}

类型	指派人员	状态
审查		进行中 (0/1)
测试		进行中 (0/1)

可及/surprisemeal .gitee-modal { width: 500px !important; }

搜索帮助

可及/surprisemeal