juwan/juwan-backend
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: 重新生成 swagger 接口文档

Browse Source
This commit is contained in:
zetaloop
2026-05-03 19:03:09 +08:00
parent 164f98cf33
commit 44c73e787f
13 changed files with 5963 additions and 5237 deletions
Download Patch File Download Diff File Expand all files Collapse all files
desc/api/docs/email-api.json
+101 -84
View File
@@ -1,121 +1,138 @@
{
"swagger": "2.0",
"info": {
"title": "",
"version": "1.0"
},
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"version": "1.0"
},
"basePath": "/",
"paths": {
"/api/v1/auth/forgot-password/send": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"summary": "忘记密码-发送验证码",
"operationId": "emailForgotPassword",
"operationId": "ForgotPassword",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/EmptyResp"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string"
}
}
"$ref": "#/definitions/ForgotPasswordReq"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object"
}
}
}
"tags": [
"email"
]
}
},
"/api/v1/email/verification-code/send": {
"post": {
"description": "向用户邮箱发送验证码，支持注册、登录、重置密码、绑定邮箱等场景",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"summary": "发送邮箱验证码",
"operationId": "emailSendVerificationCode",
"description": "向用户邮箱发送验证码，支持注册、登录、重置密码、绑定邮箱等场景",
"operationId": "SendVerificationCode",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/SendVerificationCodeResp"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"email",
"scene"
],
"properties": {
"email": {
"type": "string"
},
"scene": {
"type": "string"
}
}
"$ref": "#/definitions/SendVerificationCodeReq"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"expireInSec": {
"type": "integer"
},
"message": {
"type": "string"
},
"requestId": {
"type": "string"
}
}
}
}
}
"tags": [
"email"
]
}
}
},
"x-date": "2026-04-22 22:30:26",
"x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.10.1"
}
"definitions": {
"EmptyResp": {
"type": "object",
"title": "EmptyResp"
},
"ForgotPasswordReq": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
},
"title": "ForgotPasswordReq",
"required": [
"email"
]
},
"SendVerificationCodeReq": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"scene": {
"type": "string"
}
},
"title": "SendVerificationCodeReq",
"required": [
"email",
"required",
"scene"
]
},
"SendVerificationCodeResp": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"expireInSec": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string"
}
},
"title": "SendVerificationCodeResp",
"required": [
"requestId",
"expireInSec",
"message"
]
}
},
"securityDefinitions": {
"apiKey": {
"type": "apiKey",
"description": "Enter JWT Bearer token **_only_**",
"name": "Authorization",
"in": "header"
}
}
}