wip: 添加所有的基本模型,添加一些接口。
parent
6c7efaf22c
commit
53ee858140
@ -1,3 +1,10 @@
|
|||||||
import "base.api"
|
import "base.api"
|
||||||
|
import "auth/auth.api"
|
||||||
import "core/model.api"
|
import "core/model.api"
|
||||||
import "core/user.api"
|
import "core/user.api"
|
||||||
|
import "core/role.api"
|
||||||
|
import "core/token.api"
|
||||||
|
import "core/captcha.api"
|
||||||
|
import "core/district.api"
|
||||||
|
import "core/oauth_provider.api"
|
||||||
|
import "core/department.api"
|
||||||
|
@ -0,0 +1,11 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
// CaptchaInfo | 验证码信息
|
||||||
|
type (
|
||||||
|
CaptchaInfo {
|
||||||
|
// CaptchaId | 验证码ID
|
||||||
|
CaptchaId string `json:"captchaId"`
|
||||||
|
// ImgPath | 验证码图片路径
|
||||||
|
ImgPath string `json:"imgPath"`
|
||||||
|
}
|
||||||
|
)
|
@ -0,0 +1,38 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
type (
|
||||||
|
// Validating captcha request | 验证验证码请求
|
||||||
|
ValidateCaptchaReq {
|
||||||
|
// Captcha ID which store in redis | 图形验证码编号, 存在redis中
|
||||||
|
//
|
||||||
|
// Required: true
|
||||||
|
// Max length: 32
|
||||||
|
CaptchaId string `json:"captchaId" validate:"len=32"`
|
||||||
|
|
||||||
|
// The Captcha which users input | 用户输入的验证码
|
||||||
|
//
|
||||||
|
// Required: true
|
||||||
|
// Max length: 4
|
||||||
|
Captcha string `json:"captcha" validate:"len=4"`
|
||||||
|
|
||||||
|
// Auto remove captcha | 自动删除被验证的验证码
|
||||||
|
//
|
||||||
|
// Required: false
|
||||||
|
Clear bool `json:"clear,optional"`
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@server(
|
||||||
|
group: captcha
|
||||||
|
prefix: /api/captcha
|
||||||
|
)
|
||||||
|
service api {
|
||||||
|
// Get Captcha | 获取验证码
|
||||||
|
@handler getCaptcha
|
||||||
|
get / returns (CaptchaInfo)
|
||||||
|
|
||||||
|
// Validating captcha | 验证验证码正确性
|
||||||
|
@handler validateCaptcha
|
||||||
|
post /validate (ValidateCaptchaReq)
|
||||||
|
}
|
@ -0,0 +1,56 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
type (
|
||||||
|
// Department request | 部门查询请求
|
||||||
|
// swagger:parameters GetDepartmentListAdmin GetDepartmentAdmin
|
||||||
|
DepartmentReq {
|
||||||
|
BaseID
|
||||||
|
*Pagination
|
||||||
|
|
||||||
|
// 部门名称
|
||||||
|
Name string `json:"name,optional" form:"name,optional"`
|
||||||
|
|
||||||
|
// Leader ID | 负责人ID
|
||||||
|
LeaderID int64 `json:"leaderId,string,optional" form:"leaderId,optional"`
|
||||||
|
|
||||||
|
// Parent ID | 父节点ID
|
||||||
|
ParentID int64 `json:"parentId,string,optional" form:"parentId,optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Department list response | 部门列表返回
|
||||||
|
DepartmentListResp {
|
||||||
|
// Page | 分页数据
|
||||||
|
Page *Pagination `json:"page,optional"`
|
||||||
|
|
||||||
|
// List | 数据列表
|
||||||
|
List []*DepartmentInfo `json:"list"`
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
@server(
|
||||||
|
jwt: Auth
|
||||||
|
group: department_admin
|
||||||
|
middleware: Authority
|
||||||
|
prefix: /api/admin/department
|
||||||
|
)
|
||||||
|
service api {
|
||||||
|
// Create department | 创建部门
|
||||||
|
@handler createDepartmentAdmin
|
||||||
|
post /create (DepartmentInfo) returns (BaseID)
|
||||||
|
|
||||||
|
// Update department info | 更新部门信息
|
||||||
|
@handler updateDepartmentAdmin
|
||||||
|
post /update (DepartmentInfo)
|
||||||
|
|
||||||
|
// Get department list | 获取部门列表
|
||||||
|
@handler getDepartmentListAdmin
|
||||||
|
get /list (DepartmentReq) returns (DepartmentListResp)
|
||||||
|
|
||||||
|
// Get department | 获取部门
|
||||||
|
@handler getDepartmentAdmin
|
||||||
|
get / (DepartmentReq) returns (DepartmentInfo)
|
||||||
|
|
||||||
|
// Delete department | 删除部门
|
||||||
|
@handler deleteDepartmentAdmin
|
||||||
|
delete / (BaseID)
|
||||||
|
}
|
@ -0,0 +1,56 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
type (
|
||||||
|
// Dictionary request | 字典查询请求
|
||||||
|
// swagger:parameters GetDictionaryListAdmin GetDictionaryAdmin
|
||||||
|
DictionaryReq {
|
||||||
|
BaseID
|
||||||
|
*Pagination
|
||||||
|
|
||||||
|
// 展示名称
|
||||||
|
Title string `json:"title,optional" form:"title,optional"`
|
||||||
|
|
||||||
|
// 搜索名称
|
||||||
|
Name string `json:"name,optional" form:"name,optional"`
|
||||||
|
|
||||||
|
// Keyword | 综合搜索关键字
|
||||||
|
Keyword string `json:"keyword,optional" form:"keyword,optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dictionary list response | 字典列表返回
|
||||||
|
DictionaryListResp {
|
||||||
|
// Page | 分页数据
|
||||||
|
Page *Pagination `json:"page,optional"`
|
||||||
|
|
||||||
|
// List | 数据列表
|
||||||
|
List []*DictionaryInfo `json:"list"`
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
@server(
|
||||||
|
jwt: Auth
|
||||||
|
group: dictionary_admin
|
||||||
|
middleware: Authority
|
||||||
|
prefix: /api/admin/dictionary
|
||||||
|
)
|
||||||
|
service api {
|
||||||
|
// Create dictionary | 创建字典
|
||||||
|
@handler createDictionaryAdmin
|
||||||
|
post /create (DictionaryInfo) returns (BaseID)
|
||||||
|
|
||||||
|
// Update dictionary info | 更新字典信息
|
||||||
|
@handler updateDictionaryAdmin
|
||||||
|
post /update (DictionaryInfo)
|
||||||
|
|
||||||
|
// Get dictionary list | 获取字典列表
|
||||||
|
@handler getDictionaryListAdmin
|
||||||
|
get /list (DictionaryReq) returns (DictionaryListResp)
|
||||||
|
|
||||||
|
// Get dictionary | 获取字典
|
||||||
|
@handler getDictionaryAdmin
|
||||||
|
get / (DictionaryReq) returns (DictionaryInfo)
|
||||||
|
|
||||||
|
// Delete dictionary | 删除字典
|
||||||
|
@handler deleteDictionaryAdmin
|
||||||
|
delete / (BaseID)
|
||||||
|
}
|
@ -0,0 +1,57 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
type (
|
||||||
|
// OAuth provider request | OAuth提供商查询请求
|
||||||
|
// swagger:parameters GetOauthProviderAdmin GetOauthProviderListAdmin
|
||||||
|
OauthProviderReq {
|
||||||
|
BaseID
|
||||||
|
*Pagination
|
||||||
|
|
||||||
|
// Name | 第三方提供商名称
|
||||||
|
//
|
||||||
|
// Required: false
|
||||||
|
// Example: wechat
|
||||||
|
Name string `form:"name,optional"`
|
||||||
|
|
||||||
|
// ClientId | 第三方客户端ID (like)
|
||||||
|
//
|
||||||
|
// Required: false
|
||||||
|
// Example: wx21k2j193j2ksdfaak291l
|
||||||
|
ClientId string `form:"clientId,optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OAuth provider list response | OAuth提供商查询返回
|
||||||
|
OauthProviderListResp {
|
||||||
|
Page *Pagination `json:"page,optional"`
|
||||||
|
|
||||||
|
List []*OauthProviderInfo `json:"list"`
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
@server(
|
||||||
|
jwt: Auth
|
||||||
|
group: oauthprovider_admin
|
||||||
|
middleware: Authority
|
||||||
|
prefix: /api/admin/oauth_provider
|
||||||
|
)
|
||||||
|
service api {
|
||||||
|
// Create oauth provider information | 创建第三方信息
|
||||||
|
@handler createOauthProviderAdmin
|
||||||
|
post /create (OauthProviderInfo)
|
||||||
|
|
||||||
|
// Update oauth provider information | 更新第三方信息
|
||||||
|
@handler updateOauthProviderAdmin
|
||||||
|
post /update (OauthProviderInfo)
|
||||||
|
|
||||||
|
// Delete oauth provider information | 删除第三方信息
|
||||||
|
@handler deleteOauthProviderAdmin
|
||||||
|
post /delete (BaseIDs)
|
||||||
|
|
||||||
|
// Get oauth provider list | 获取第三方信息列表
|
||||||
|
@handler getOauthProviderListAdmin
|
||||||
|
get /list (OauthProviderReq) returns (OauthProviderListResp)
|
||||||
|
|
||||||
|
// Get oauth provider by Params | 根据条件获取第三方信息
|
||||||
|
@handler getOauthProviderAdmin
|
||||||
|
get / (OauthProviderReq) returns (OauthProviderInfo)
|
||||||
|
}
|
@ -0,0 +1,49 @@
|
|||||||
|
syntax = "v1"
|
||||||
|
|
||||||
|
type (
|
||||||
|
// Token request | 查询凭证请求
|
||||||
|
// swagger:parameters GetTokenListAdmin
|
||||||
|
TokenReq {
|
||||||
|
BaseID
|
||||||
|
*Pagination
|
||||||
|
|
||||||
|
// User id | 用户ID
|
||||||
|
UserID int64 `json:"userId,string,optional" form:"userId,string,optional"`
|
||||||
|
|
||||||
|
// Token status | Token状态
|
||||||
|
Status string `json:"status,optional" form:"status,optional"`
|
||||||
|
|
||||||
|
// Provider source | 提供商来源
|
||||||
|
Source string `json:"source,optional" form:"source,optional"`
|
||||||
|
|
||||||
|
// Token type | 凭证类型 [Bearer]
|
||||||
|
//
|
||||||
|
// Example: Bearer
|
||||||
|
TokenType string `json:"tokenType,optional" form:"tokenType,optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Token list response | 凭证列表返回
|
||||||
|
TokenListResp {
|
||||||
|
// Page | 分页数据
|
||||||
|
Page *Pagination `json:"page,optional"`
|
||||||
|
|
||||||
|
// List | 数据列表
|
||||||
|
List []TokenInfo `json:"list"`
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
@server(
|
||||||
|
group: token_admin
|
||||||
|
prefix: /api/admin/token
|
||||||
|
jwt: Auth
|
||||||
|
middleware: Authority
|
||||||
|
)
|
||||||
|
service api {
|
||||||
|
// Get token list | 获取凭证列表
|
||||||
|
@handler getTokenListAdmin
|
||||||
|
get /list (TokenReq) returns (TokenListResp)
|
||||||
|
|
||||||
|
// Disable token | 禁用凭证(强制下线)
|
||||||
|
@handler disableTokenAdmin
|
||||||
|
post /disable (BaseID)
|
||||||
|
}
|
Loading…
Reference in New Issue