首页 > 其他分享 >大事件接口文档

大事件接口文档

时间：2023-11-30 18:22:05浏览次数：31  
标签：请求 number 接口 响应 文档 事件 必须 参数 string

大事件接口文档

大事件接口文档-V1.0

1. 用户相关接口

1.1 注册

1.1.1 基本信息

请求路径：/user/register

请求方式：POST

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

1.1.2 请求参数

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

请求参数说明：

参数名称 说明 类型 是否必须 备注
username 用户名 string 是 5~16位非空字符
password 密码 string 是 5~16位非空字符

请求数据样例：

username=zhangsan&password=123456

1.1.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

1.2 登录

1.2.1 基本信息

请求路径：/user/login

请求方式：POST

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

1.2.2 请求参数

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

请求参数说明：

参数名称 说明 类型 是否必须 备注
username 用户名 string 是 5~16位非空字符
password 密码 string 是 5~16位非空字符

请求数据样例：

username=zhangsan&password=123456

1.2.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data string 必须 返回的数据,jwt令牌

响应数据样例：

{
    "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 number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 必须 返回的数据
|-id number 非必须 主键ID
|-username srting 非必须 用户名
|-nickname string 非必须 昵称
|-email string 非必须 邮箱
|-userPic string 非必须 头像地址
|-createTime string 非必须 创建时间
|-updateTime string 非必须 更新时间

响应数据样例：

{
    "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 主键ID number 是
username 用户名 string 否 5~16位非空字符
nickname 昵称 string 是 1~10位非空字符
email 邮箱 string 是 满足邮箱的格式

请求数据样例：

{
    "id":5,
    "username":"wangba",
    "nickname":"wb",
    "email":"[email protected]"
}

1.4.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

1.5 更新用户头像

1.5.1 基本信息

请求路径：/user/updateAvatar

请求方式：PATCH

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

1.5.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称 说明 类型 是否必须 备注
avatarUrl 头像地址 string 是 url地址

请求数据样例：

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

1.5.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

1.6 更新用户密码

1.6.1 基本信息

请求路径：/user/updatePwd

请求方式：PATCH

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

1.6.2 请求参数

请求参数格式：application/json

请求参数说明：

参数名称 说明 类型 是否必须 备注
old_pwd 原密码 string 是
new_pwd 新密码 string 是
re_pwd 确认新密码 string 是

请求数据样例：

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

1.6.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

2. 文章分类相关接口

2.1 新增文章分类

2.1.1 基本信息

请求路径：/category

请求方式：POST

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

2.1.2 请求参数

请求参数格式：application/json

请求参数说明：

参数名称 说明 类型 是否必须 备注
categoryName 分类名称 string 是
categoryAlias 分类别名 string 是

请求数据样例：

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

2.1.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

2.2 文章分类列表

2.2.1 基本信息

请求路径：/category

请求方式：GET

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

2.2.2 请求参数

无

2.2.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data array 必须 返回的数据
|-id number 非必须 主键ID
|-categoryName string 非必须 分类名称
|-categoryAlias string 非必须 分类别名
|-createTime string 非必须 创建时间
|-updateTime string 非必须 修改时间

响应数据样例：

{
    "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 主键ID number 是

请求数据样例：

id=6

2.3.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 必须 返回的数据
|-id number 非必须 主键ID
|-categoryName string 非必须 分类名称
|-categoryAlias string 非必须 分类别名
|-createTime string 非必须 创建时间
|-updateTime string 非必须 修改时间

响应数据样例：

{
    "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 主键ID number 是
categoryName 分类名称 string 是
categoryAlias 分类别名 string 是

请求数据样例：

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

2.4.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

2.5 删除文章分类

2.5.1 基本信息

请求路径：/category

请求方式：DELETE

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

2.5.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称 说明 类型 是否必须 备注
id 主键ID number 是

请求数据样例：

id=6

2.5.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

3. 文章管理相关接口

3.1 新增文章

3.1.1 基本信息

请求路径：/article

请求方式：POST

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

3.1.2 请求参数

请求参数格式：application/json

请求参数说明：

参数名称 说明 类型 是否必须 备注
title 文章标题 string 是 1~10个非空字符
content 文章正文 string 是
coverImg 封面图像地址 string 是 必须是url地址
state 发布状态 string 是 已发布 | 草稿
categoryId 文章分类ID number 是

请求数据样例：

{
  "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 number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

3.2 文章列表(条件分页)

3.2.1 基本信息

请求路径：/article

请求方式：GET

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

3.2.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称 说明 类型 是否必须 备注
pageNum 当前页码 number 是
pageSize 每页条数 number 是
categoryId 文章分类ID number 否
state 发布状态 string 否 已发布 | 草稿

请求数据样例：

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

3.2.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 必须 返回的数据
|-total number 必须 总记录数
|-items array 必须 数据列表
|-id number 非必须 主键ID
|-title string 非必须 文章标题
|-content string 非必须 文章正文
|-coverImg string 非必须 文章封面图像地址
|-state string 非必须 发布状态 已发布|草稿
|-categoryId number 非必须 文章分类ID
|-createTime string 非必须 创建时间
|-updateTime string 非必须 更新时间

响应数据样例：

{
    "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 主键ID number 是

请求数据样例：

id=4

3.3.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 必须 返回的数据
|-id number 非必须 主键ID
|-title string 非必须 文章标题
|-content string 非必须 文章正文
|-coverImg string 非必须 文章封面图像地址
|-state string 非必须 发布状态 已发布|草稿
|-categoryId number 非必须 文章分类ID
|-createTime string 非必须 创建时间
|-updateTime string 非必须 更新时间

响应数据样例：

{
    "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 主键ID number 是
title 文章标题 string 是
content 文章正文 string 是
coverImg 封面图像地址 string 是
state 发布状态 string 是 已发布 | 草稿
categoryId 文章分类ID number 是

请求数据样例：

{
    "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 number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

3.5 删除文章

3.5.1 基本信息

请求路径：/article

请求方式：DELETE

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

3.5.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称 说明 类型 是否必须 备注
id 主键ID number 是

请求数据样例：

id=4

3.5.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data object 非必须 返回的数据

响应数据样例：

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

4. 其他接口

4.1 文件上传

4.1.1 基本信息

请求路径：/upload

请求方式：POST

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

4.1.2 请求参数

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

请求参数说明：

参数名称 说明 类型 是否必须 备注
file 表单中文件请求参数的名字 file 是

请求数据样例：

无

4.1.3 响应数据

响应数据类型：application/json

响应参数说明：

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 响应码, 0-成功,1-失败
message string 非必须 提示信息
data string 必须 图像在阿里云上的存储地址

响应数据样例：

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

标签：请求,number,接口,响应,文档,事件,必须,参数,string
From： https://www.cnblogs.com/wefriend/p/large-event-interface-document-z2s1a58.html

相关文章

  • Jmeter接口自动化测试 —— Jmeter变量的使用
    ​在使用jmeter进行接口测试时，我们难免会遇到需要从上下文中获取测试数据的情况，这个时候就需要引入变量了。定义变量添加->配置元件->用户自定义的变量添加->配置元件->CSV数据文件设置变量的调用方式：${变量名}变量的作用范围：变量可以写入任何测试组件的任何字段中（除了T......
  • Jmeter接口自动化测试 —— Jmeter断言之Json断言
     json断言可以让我们很快的定位到响应数据中的某一字段，当然前提是响应数据是json格式的，所以如果响应数据为json格式的话，使用json断言还是相当方便的。还是以之前的接口举例Url:https://data.cma.cn/weatherGis/web/weather/weatherFcst/getCurrentConditionHTTPMethod:Po......
  • 防止接口重复调用方法
    1、使用数据库唯一索引:为需要防重复的字段添加唯一索引,再尝试插入,如果重复会报错。2、使用线程本地变量利用ThreadLocal存储是否调用过的标识变量。privatestaticfinalThreadLocal<Bolean>CALLED=newThreadLocal<>();if(CALLED.get()!=null){//已调用}else......
  • E8重写已有JS事件
    window.onload=function(){overwriteSubmit(function(){//验证成功返回truealert("12312312");returntrue;//验证失败返回false});};/***重写保存事件。*/varoverwriteSubmit=function(onSubmit){vardoSave_nNewOld=doSave_nNew;d......
  • vue3页面中，两个相同组件，一个卸载，一个挂载，后展示的组件事件监听不生效？
    场景：在实际开发中，遇到了这样一种场景，vue3页面，两个相同组件，在满足某条件下展示第一个组件，满足另一个条件下，隐藏第一个组件，同时展示第二个组件，比如反馈组件，会通过window.addEventListener来监听自定义的反馈弹窗展示和隐藏事件。结果：两个相同组件一个卸载，一个挂载，第一个组监听的......
  • 2023-11-30 记录实用小案例 —— react监听页面返回时执行事件
    useEffect(()=>{consthandlePageBack=()=>{//此处写你想要触发的事件};//监听浏览器的popstate事件，即页面返回事件window.addEventListener('popstate',handlePageBack);//在组件卸载时移除事件监听return()=>{......
  • go数据类型-空结构体、空接口、nil
    空结构体funcmain(){ a:=struct{}{} fmt.Println(unsafe.Sizeof(a)) fmt.Printf("%p\n",&a)}打印00x117f4e0有经验的开发人员都知道，所有的空结构体是指向一个zerobase的地址，而且大小为0一般用来作结合map作为set或者在channel中传递信号。t......
  • Java集合框架主要接口及实现类详解
    Java集合框架是Java编程语言提供的一组接口，用于处理对象集合。Java集合框架中包括了一系列的接口、实现类和算法，可以方便地操作和管理各种类型的集合数据。Java集合框架主要包括以下接口：Collection接口：是所有集合接口的根接口，提供了基本的集合操作，如添加、删除、遍历等操作。L......
  • 基于主成分分析的学生学习状况的影响因素分析——文档
    知识经济时代，高等教育在培养人才方面发挥了重要作用。但是我国高等教育存在一些问题，因此关于高等教育改革的呼声日益高涨。改革的前提是对教育主体学生有较为清晰的认知，因此学情调查至关重要。本文基于主成分析变革高等教育培养方式，培养学生学习能力和研究能力，提高教学质量和效果，......
  • 无涯教程-F# - 事件类型
    事件允许类之间相互发送和接收消息，对象通过同步消息传递相互通信。事件类和事件模块Control.Event<'T>类有助于创建可观察的对象或事件。Member说明Publish将观察输出作为一等值发布。Trigger使用给定的参数触发观察。Control.Event模块提供用于管理事件流的功能-Valu......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99