首页 > 其他分享 >OpenAPI definition（示例）

OpenAPI definition（示例）

时间：2024-09-05 18:26:21浏览次数：9  
标签：definition string 示例 数据类型 OpenAPI 响应 参数 int32 integer

OpenAPI 规范 (中文版) (apifox.cn)

OpenAPI definition-CSDN博客

 

简介:OpenAPI definition

HOST:http://192.168.41.191:8902/api/v1/user

联系人:

Version:v0

接口路径:/user/v3/api-docs

[TOC]

学校管理
获取学校列表
接口地址:/user/schools

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取系统所有支持列表，供个人中心下拉框使用

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK BaseResponseListSchoolVO
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 array SchoolVO
  id 学校id integer(int64)
  schoolName 学校名称 string
  schoolAbbr 学校缩写 string
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": [
{
"id": 1789548655582642177,
"schoolName": "哈尔滨理工大学",
"schoolAbbr": "HRBUST"
}
],
"msg": "success"
}
用户管理
获取用户登录信息
接口地址:/user/

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

常常用于第一次登陆成功或路由守卫检查用户登录态

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK BaseResponseUserDto
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data UserDto UserDto
  userId 用户id integer(int64)
  username 用户名 string
  nickname 用户昵称 string
  gender 用户性别 string
  age 用户年龄 integer(int32)
  userAvatar 用户头像url string
  email 用户邮箱 string
  schoolName 用户所属学校名称 string
  schoolAbbr 用户所属学校简写 string
  totalLikes 用户在社区模块的获赞总数 integer(int32)
  totalComments 用户在社区模块的被评论总数 integer(int32)
  unReadCommentsCount 用户未读评论的总数 integer(int32)
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {
"userId": 1789548655582642177,
"username": "nick123",
"nickname": "尼克",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "[email protected]",
"schoolName": "哈尔滨理工大学",
"schoolAbbr": "HRBUST",
"totalLikes": 100,
"totalComments": 200,
"unReadCommentsCount": 10
},
"msg": "success"
}
修改用户信息
接口地址:/user/

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
"nickname": "尼克",
"password": "123456",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "[email protected]",
"schoolAbbr": "HRBUST"
}
请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
updateUserDto 更新用户信息dto body true UpdateUserDto UpdateUserDto
  nickname 用户昵称 false string
  password 用户密码(不传为空) false string
  gender 用户性别 false string
  age 用户年龄 false integer(int32)
  userAvatar 用户头像的url false string
  email 用户邮箱 false string
  schoolAbbr 用户学校(英文简写而非学校名称) false string
响应状态:

状态码 说明 schema
200 OK BaseResponseObject
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 object
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {},
"msg": "success"
}
用户注销
接口地址:/user/

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK BaseResponseObject
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 object
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {},
"msg": "success"
}
检查用户id是否合法
接口地址:/user/id

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

供后端系统远程调用，前端不需关注

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id query true integer(int64)
响应状态:

状态码 说明 schema
200 OK
响应参数:

暂无

响应示例:


用户登录
接口地址:/user/login

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
"username": "",
"password": ""
}
请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
loginDto 用户登录DTO body true LoginDto LoginDto
  username 用户名 true string
  password 用户密码 true string
响应状态:

状态码 说明 schema
200 OK BaseResponseString
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 string
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": "",
"msg": "success"
}
获取用户所有未读信息
接口地址:/user/messages

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK BaseResponseListMessageDto
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 array MessageDto
  id 消息id integer(int64)
  userId 当前评论用户id（回复你的评论） integer(int64)
  userNickname 回复评论的用户昵称 string
  objName 当前评论所属点评对象 string
  objId 当前评论所属点评对象id integer(int64)
  replyUserId 被回复的用户id integer(int64)
  replyCommentId 被回复的评论id integer(int64)
  content 回复的评论内容 string
  likes 评论所获点赞数 integer(int32)
  pubTime 评论发布时间 string(date-time)
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": [
{
"id": 1789548655582642177,
"userId": 1789548655582642177,
"userNickname": "张三",
"objName": "服务端架构设计",
"objId": 1789548655582642177,
"replyUserId": 1789548655582642177,
"replyCommentId": 1789548655582642177,
"content": "你说的对，但是......",
"likes": 100,
"pubTime": ""
}
],
"msg": "success"
}
将消息标记为已读
接口地址:/user/read/messages

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

点击去查看以后发送的请求

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
messageId 要标记的消息id query true integer(int64)
响应状态:

状态码 说明 schema
200 OK BaseResponseObject
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 object
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {},
"msg": "success"
}
用户注册
接口地址:/user/register

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
"username": "",
"password": ""
}
请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
loginDto 用户登录DTO body true LoginDto LoginDto
  username 用户名 true string
  password 用户密码 true string
响应状态:

状态码 说明 schema
200 OK BaseResponseObject
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 object
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {},
"msg": "success"
}
获取用户信息
接口地址:/user/rpc

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

供后端系统远程调用，前端不需关注

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id header true integer(int64)
响应状态:

状态码 说明 schema
200 OK BaseResponseUserDto
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data UserDto UserDto
  userId 用户id integer(int64)
  username 用户名 string
  nickname 用户昵称 string
  gender 用户性别 string
  age 用户年龄 integer(int32)
  userAvatar 用户头像url string
  email 用户邮箱 string
  schoolName 用户所属学校名称 string
  schoolAbbr 用户所属学校简写 string
  totalLikes 用户在社区模块的获赞总数 integer(int32)
  totalComments 用户在社区模块的被评论总数 integer(int32)
  unReadCommentsCount 用户未读评论的总数 integer(int32)
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": {
"userId": 1789548655582642177,
"username": "nick123",
"nickname": "尼克",
"gender": "男",
"age": 20,
"userAvatar": "https://ischool-bucket.oss-cn-beijing.aliyuncs.com/4c079b7b-0873-4c99-a666-0874a1595811.jpg",
"email": "[email protected]",
"schoolName": "哈尔滨理工大学",
"schoolAbbr": "HRBUST",
"totalLikes": 100,
"totalComments": 200,
"unReadCommentsCount": 10
},
"msg": "success"
}
文件上传
接口地址:/user/upload

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
file 文件对象 query false file
响应状态:

状态码 说明 schema
200 OK BaseResponseString
响应参数:

参数名称 参数说明 类型 schema
code 响应码，成功为0其他（4xxxx客户端错误，5xxxx服务端错误） integer(int32) integer(int32)
data 响应数据 string
msg 响应消息，成功为success，错误返回失败信息 string
响应示例:

{
"code": 0,
"data": "",
"msg": "success"

 

标签：definition,string,示例,数据类型,OpenAPI,响应,参数,int32,integer
From： https://www.cnblogs.com/cheyunhua/p/18399007

相关文章

  • Rust 中的关键字以及示例
    1.常见关键字as:用于类型转换，例如将一个值从一种类型转换为另一种类型。letx:i32=42;lety:u8=xasu8;break:用于提前退出循环。foriin0..10{ifi==5{break;}}const:定义一个常量，常量的值在编译时就确定，不会在运行时改变。......
  • 基于SpringBoot的高校宿舍管理系统+LW参考示例
    系列文章目录1.基于SSM的洗衣房管理系统+原生微信小程序+LW参考示例2.基于SpringBoot的宠物摄影网站管理系统+LW参考示例3.基于SpringBoot+Vue的企业人事管理系统+LW参考示例4.基于SSM的高校实验室管理系统+LW参考示例5.基于SpringBoot的二手数码回收系统+原生微信小......
  • 基于SpringBoot的电影院订票系统+LW示例参考
    系列文章目录1.基于SSM的洗衣房管理系统+原生微信小程序+LW参考示例2.基于SpringBoot的宠物摄影网站管理系统+LW参考示例3.基于SpringBoot+Vue的企业人事管理系统+LW参考示例4.基于SSM的高校实验室管理系统+LW参考示例5.基于SpringBoot的二手数码回收系统+原生微信小......
  • 基于云函数的自习室预约微信小程序+LW示例参考
    全阶段全种类学习资源，内涵少儿、小学、初中、高中、大学、专升本、考研、四六级、建造师、法考、网赚技巧、毕业设计等，持续更新~文章目录@[TOC](文章目录)1.项目介绍2.项目部署3.项目部分截图4.获取方式1.项目介绍技术栈+工具：云数据库+云函数+JS+原生微信小......
  • 神经网络之卷积篇：详解卷积神经网络示例（Convolutional neural network example）
    详解卷积神经网络示例假设，有一张大小为32×32×3的输入图片，这是一张RGB模式的图片，想做手写体数字识别。32×32×3的RGB图片中含有某个数字，比如7，想识别它是从0-9这10个数字中的哪一个，构建一个神经网络来实现这个功能。用的这个网络模型和经典网络LeNet-5非常相似，灵感也来源于此......
  • 字典元素的访问示例
    '''可以对字典对象进行迭代或者遍历，默认是遍历字典的键，如果需要遍历字典的元素必须使用字典对象的items()方法明确说明，如果需要遍历字典的值则必须使用字典对象的values()方法明确说明'''Dict={'age':18,'name':'Zheng','sex':'male'}#遍历输出字典的键foriteminDict:  ......
  • 决策树之——C4.5算法及示例
    0前言本文主要讲述了决策树C4.5算法构建原理并举例说明。读者需要具备的知识有：信息熵、条件熵、信息增益、信息增益比。本文所使用的数据集为：西瓜数据集1.2节。1C4.5算法流程准备数据集：输入数据集包含多个样本，每个样本具有多个特征（属性）和一个目标类别标签。设置阈......
  • Node.js发票查验接口示例、识别查验接口参数返回
    财务、审计等经常与发票打交道的人员常常会遇到虚假发票、错票、重复报销等一系列问题。对于会计审计、代理记账、电子商务等发票查验量多的企业来说，成千上万张发票如果仅依赖于人工来进行核验，速度慢效率低，准确率也没保障，因此，如何让发票查验工作变得便捷高效，提升发票查验的效......
  • Node.js实名认证接口示例-身份证、银行卡、手机号实名认证
    随着互联网的高速发展，人们可以发表言论的渠道越来越多。网络平台不断汲取各地、各人、各时发表的各种信息。人们喜欢将信息发布到微博、知乎、天涯、豆瓣等等网络平台，逐步的，网络信息进入大爆炸时代。这些大量涌现的信息中难免掺杂着一些不良信息，比如：虚假信息、污言秽语、违法......
  • Node.js发票查验接口示例、识别查验接口参数返回
     财务、审计等经常与发票打交道的人员常常会遇到虚假发票、错票、重复报销等一系列问题。对于会计审计、代理记账、电子商务等发票查验量多的企业来说，成千上万张发票如果仅依赖于人工来进行核验，速度慢效率低，准确率也没保障，因此，如何让发票查验工作变得便捷高效，提升发票查验的......

赞助商

阅读排行

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

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

Copyright © 2020-2023 IPS99 版权所有 IPS99