首页 > 其他分享 >OpenAPI definition

OpenAPI definition

时间：2024-05-26 23:33:46浏览次数：15  
标签：definition string int32 数据类型 OpenAPI 响应 参数 integer

简介:OpenAPI definition

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

联系人:

Version:v0

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

目录

学校管理

获取学校列表

接口地址:/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,int32,数据类型,OpenAPI,响应,参数,integer
From： https://www.cnblogs.com/bug-designer-cn/p/18214536

相关文章

  • Gin与OpenAPI(Swagger)的使用
    一、背景1、swagger与openapi      Swagger：            一种用于描述RESTFULAPI的规范，它提供了一种简单的来描述API的请求和相应参数、错误码、返回数据类型等信息，是开发者可以方便了解API使用方式。     官网: https://swagger.io/  ......
  • OPENAPI3.0介绍
    OpenAPI是一种描述和定义API的规范RESTfulAPI是一种设计API的方法 OPENAPI3.0介绍https://blog.csdn.net/qq_41971087/article/details/126065322https://www.cnblogs.com/yaohl0911/p/14567915.html OpenAPI 中文文档：https://openapi.apifox.cn/ 校验OpenAPI文档......
  • 我发现了字节OpenApi接口的bug！
    本文记录我在对接字节旗下产品火山云旗下云游戏产品OpenApi接口文档时遇到的坑，希望能帮助大家（火山云旗下云游戏产品的文档坑很多，我算是从零到一都踩了一遍，特此记录，希望大家引以为鉴）。1.文档问题很经典的开局一张图，对接全靠问，这里给大家强调下，当要跟第三方产品对接时，一定要......
  • OpenAPI Swagger
    一.首先你要启动你的swagger.json或者openapi.json二.然后你需要启动openapi生成代码的容器（如：python、javascript、php、golang...）我这里是pythondockerrun-d-p8090:8080--nameopenapi_generatoropenapitools/openapi-generator-online:latest-release 三.调用容......
  • 报错“Please indicate a valid Swagger or OpenAPI version field”
    报错“PleaseindicateavalidSwaggerorOpenAPIversionfield”报错信息PleaseindicateavalidSwaggerorOpenAPIversionfield.Supportedversionfieldsareswagger:"2.0"andthosethatmatchopenapi:3.0.n(forexample,openapi:3.0.0). 原因分析根......
  • SpringBoot整合OpenAPI 3生成在线接口文档
    SpringBoot整合springdoc-openapi，自动生成在线接口文档。1、引入pom依赖<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.3.0</version></dependenc......
  • Fail to create wsdl definition
    D:\Software\WebService\apache-cxf-3.3.1\bin>wsdl2java-encodingutf-8http://XXX.XXX.XXX.XXX:10051/NIS_SZLonghuaFY/EwellInterfaceService?wsdlWSDLToJavaError:org.apache.cxf.wsdl11.WSDLRuntimeException:Failtocreatewsdldefinitionhttp://XXX.X......
  • Spring 源码阅读（二）IoC 容器初始化以及 BeanFactory 创建和 BeanDefinition 加载过程
    相关代码提交记录：https://github.com/linweiwang/spring-framework-5.3.33IoC容器三种启动方式XMLJavaSE：ApplicationContextcontext=newClassPathXmlApplicationContext("beans.xml")ApplicationContextcontext=newFileSystemXmlApplicationContext("C:/beans......
  • 52 Things: Number 30: Roughly outline the BR security definition for key agreeme
    52Things:Number30:RoughlyoutlinetheBRsecuritydefinitionforkeyagreement52件事：第30件：大致概述密钥协议的BR安全定义 Thisisthelatestinaseriesofblogpoststoaddressthelistof'52ThingsEveryPhDStudentShouldKnowToDoCryptography':a......
  • 52 Things: Number 32: difference between game-based and simulation-based securit
    52Things:Number32:differencebetweengame-basedandsimulation-basedsecuritydefinitions52件事：数字32：基于游戏和基于模拟的安全定义之间的区别 Thisisthelatestinaseriesofblogpoststoaddressthelistof'52ThingsEveryPhDStudentShouldKnowt......

赞助商

阅读排行

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

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

Copyright © 2020-2023 IPS99 版权所有 IPS99