大事件接口文档

大事件接口文档-V1.0

1. 用户相关接口

1.1 注册

1.1.1 基本信息

请求路径：/user/register

请求方式：POST

接口描述：该接口用于注册新用户

1.1.2 请求参数

请求参数格式：x-www-form-urlencoded

请求参数说明：

请求数据样例：

username=zhangsan&password=123456

1.1.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

1.2 登录

1.2.1 基本信息

请求路径：/user/login

请求方式：POST

接口描述：该接口用于登录

1.2.2 请求参数

请求参数格式：x-www-form-urlencoded

请求参数说明：

请求数据样例：

username=zhangsan&password=123456

1.2.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGFpbXMiOnsiaWQiOjUsInVzZXJuYW1lIjoid2FuZ2JhIn0sImV4cCI6MTY5MzcxNTk3OH0.pE_RATcoF7Nm9KEp9eC3CzcBbKWAFOL0IsuMNjnZ95M"
}

1.2.4 备注说明

用户登录成功后，系统会自动下发JWT令牌，然后在后续的每次请求中，浏览器都需要在请求头header中携带到服务端，请求头的名称为 Authorization，值为 登录时下发的JWT令牌。

如果检测到用户未登录，则http响应状态码为401

1.3 获取用户详细信息

1.3.1 基本信息

请求路径：/user/userInfo

请求方式：GET

接口描述：该接口用于获取当前已登录用户的详细信息

1.3.2 请求参数

无

1.3.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": {
        "id": 5,
        "username": "wangba",
        "nickname": "",
        "email": "",
        "userPic": "",
        "createTime": "2023-09-02 22:21:31",
        "updateTime": "2023-09-02 22:21:31"
    }
}

1.4 更新用户基本信息

1.4.1 基本信息

请求路径：/user/update

请求方式：PUT

接口描述：该接口用于更新已登录用户的基本信息(除头像和密码)

1.4.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
    "id":5,
    "username":"wangba",
    "nickname":"wb",
    "email":"wb@itcast.cn"
}

1.4.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

1.5 更新用户头像

1.5.1 基本信息

请求路径：/user/updateAvatar

请求方式：PATCH

接口描述：该接口用于更新已登录用户的头像

1.5.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

avatarUrl=
https://big-event-gwd.oss-cn-beijing.aliyuncs.com/9bf1cf5b-1420-4c1b-91ad-e0f4631cbed4.png

1.5.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

1.6 更新用户密码

1.6.1 基本信息

请求路径：/user/updatePwd

请求方式：PATCH

接口描述：该接口用于更新已登录用户的密码

1.6.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
    "old_pwd":"123456",
    "new_pwd":"234567",
    "re_pwd":"234567"
}

1.6.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

2. 文章分类相关接口

2.1 新增文章分类

2.1.1 基本信息

请求路径：/category

请求方式：POST

接口描述：该接口用于新增文章分类

2.1.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
    "categoryName":"人文",
    "categoryAlias":"rw"
}

2.1.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

2.2 文章分类列表

2.2.1 基本信息

请求路径：/category

请求方式：GET

接口描述：该接口用于获取当前已登录用户创建的所有文章分类

2.2.2 请求参数

无

2.2.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": [
        {
            "id": 3,
            "categoryName": "美食",
            "categoryAlias": "my",
            "createTime": "2023-09-02 12:06:59",
            "updateTime": "2023-09-02 12:06:59"
        },
        {
            "id": 4,
            "categoryName": "娱乐",
            "categoryAlias": "yl",
            "createTime": "2023-09-02 12:08:16",
            "updateTime": "2023-09-02 12:08:16"
        },
        {
            "id": 5,
            "categoryName": "军事",
            "categoryAlias": "js",
            "createTime": "2023-09-02 12:08:33",
            "updateTime": "2023-09-02 12:08:33"
        }
    ]
}

2.3 获取文章分类详情

2.3.1 基本信息

请求路径：/category/detail

请求方式：GET

接口描述：该接口用于根据ID获取文章分类详情

2.3.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

id=6

2.3.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": {
        "id": 6,
        "categoryName": "风土人情",
        "categoryAlias": "ftrq",
        "createTime": "2023-09-03 11:07:13",
        "updateTime": "2023-09-03 11:13:39"
    }
}

2.4 更新文章分类

2.4.1 基本信息

请求路径：/category

请求方式：PUT

接口描述：该接口用于更新文章分类

2.4.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
    "id":6,
    "categoryName":"风土人情",
    "categoryAlias":"ftrq"
}

2.4.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

2.5 删除文章分类

2.5.1 基本信息

请求路径：/category

请求方式：DELETE

接口描述：该接口用于根据ID删除文章分类

2.5.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

id=6

2.5.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

3. 文章管理相关接口

3.1 新增文章

3.1.1 基本信息

请求路径：/article

请求方式：POST

接口描述：该接口用于新增文章(发布文章)

3.1.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
  "title": "陕西旅游攻略",
  "content": "兵马俑,华清池,法门寺,华山...爱去哪去哪...",
  "coverImg": "https://big-event-gwd.oss-cn-beijing.aliyuncs.com/9bf1cf5b-1420-4c1b-91ad-e0f4631cbed4.png",
  "state": "草稿",
  "categoryId": 2
}

3.1.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

3.2 文章列表(条件分页)

3.2.1 基本信息

请求路径：/article

请求方式：GET

接口描述：该接口用于根据条件查询文章,带分页

3.2.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

pageNum=1&pageSize=3&categoryId=2&state=草稿

3.2.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": {
        "total": 1,
        "items": [
            {
                "id": 5,
                "title": "陕西旅游攻略",
                "content": "兵马俑,华清池,法门寺,华山...爱去哪去哪...",
                "coverImg": "https://big-event-gwd.oss-cn-beijing.aliyuncs.com/9bf1cf5b-1420-4c1b-91ad-e0f4631cbed4.png",
                "state": "草稿",
                "categoryId": 2,
                "createTime": "2023-09-03 11:55:30",
                "updateTime": "2023-09-03 11:55:30"
            }
        ]
    }
}

3.3 获取文章详情

3.3.1 基本信息

请求路径：/article/detail

请求方式：GET

接口描述：该接口用于根据ID获取文章详细信息

3.3.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

id=4

3.3.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": {
        "id": 4,
        "title": "北京旅游攻略",
        "content": "天安门,颐和园,鸟巢,长城...爱去哪去哪...",
        "coverImg": "https://big-event-gwd.oss-cn-beijing.aliyuncs.com/9bf1cf5b-1420-4c1b-91ad-e0f4631cbed4.png",
        "state": "已发布",
        "categoryId": 2,
        "createTime": "2023-09-03 11:35:04",
        "updateTime": "2023-09-03 11:40:31"
    }
}

3.4 更新文章

3.4.1 基本信息

请求路径：/article

请求方式：PUT

接口描述：该接口用于更新文章信息

3.4.2 请求参数

请求参数格式：application/json

请求参数说明：

请求数据样例：

{
    "id":4,
    "title": "北京旅游攻略",
    "content": "天安门,颐和园,鸟巢,长城...爱去哪去哪...",
    "coverImg": "https://big-event-gwd.oss-cn-beijing.aliyuncs.com/9bf1cf5b-1420-4c1b-91ad-e0f4631cbed4.png",
    "state": "已发布",
    "categoryId": 2
}

3.4.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

3.5 删除文章

3.5.1 基本信息

请求路径：/article

请求方式：DELETE

接口描述：该接口用于根据ID删除文章

3.5.2 请求参数

请求参数格式：queryString

请求参数说明：

请求数据样例：

id=4

3.5.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": null
}

4. 其他接口

4.1 文件上传

4.1.1 基本信息

请求路径：/upload

请求方式：POST

接口描述：该接口用于上传文件(单文件)

4.1.2 请求参数

请求参数格式：multipart/form-data

请求参数说明：

请求数据样例：

无

4.1.3 响应数据

响应数据类型：application/json

响应参数说明：

响应数据样例：

{
    "code": 0,
    "message": "操作成功",
    "data": "https://big-event-gwd.oss-cn-beijing.aliyuncs.com/b5811871-acc8-4583-8399-cf0dc73591ab.png"
}

本栏目推荐文章
• Java实现在线编辑预览office文档
• PasteSpider之接口的授权实现为什么不采用JWT方式
• Chrome 浏览器插件 V3 版本 Manifest.json 文件中 Action 的类型（Types）、方法（Methods）和事件（Events）的属性和参数解析
• Dating Java8系列之Lambda表达式和函数式接口（上）
• Dating Java8系列之Lambda表达式和函数式接口（下）
• 通过API接口操作vmware vcenter虚拟机
• ES--RestClient查询文档
• 测试文档
• TVBox等智能电视第三方APP可用直播源接口【截止24.01.12】
• Unity3d_Rewired官方文档翻译：要点（四）：Rewired Editor->All Maps、Layout Rules、Map Enabler

接口 事件 文档接口 事件 文档 接口 文档 bootstarp事件 文档 接口apipost文档 springboot接口swagger文档 接口swagger文档nestjs springboot接口knife4j文档 接口swagger文档spring 接口knife4j文档knife4 接口 需求diamond文档