3431 lines
84 KiB
YAML
3431 lines
84 KiB
YAML
definitions:
|
|
errors.Error:
|
|
properties:
|
|
code:
|
|
type: integer
|
|
detail:
|
|
type: string
|
|
id:
|
|
type: string
|
|
status:
|
|
type: string
|
|
type: object
|
|
schema.Article:
|
|
properties:
|
|
content:
|
|
type: string
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
link:
|
|
type: string
|
|
pushAt:
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
title:
|
|
description: Display name of banner
|
|
type: string
|
|
type:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.ArticleForm:
|
|
properties:
|
|
content:
|
|
type: string
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
link:
|
|
type: string
|
|
pushAt:
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
title:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
type:
|
|
description: Type of menu (banner, link) // Parent menu``
|
|
enum:
|
|
- banner
|
|
- home
|
|
- achievement
|
|
- honor
|
|
- talent_center
|
|
- team
|
|
- news
|
|
type: string
|
|
required:
|
|
- status
|
|
- title
|
|
- type
|
|
type: object
|
|
schema.Banner:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
link:
|
|
type: string
|
|
name:
|
|
description: Display name of banner
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
type:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: integer
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.BannerForm:
|
|
properties:
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
link:
|
|
type: string
|
|
name:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
type:
|
|
description: Type of menu (banner, link) // Parent menu``
|
|
type: integer
|
|
required:
|
|
- name
|
|
- status
|
|
- type
|
|
type: object
|
|
schema.Captcha:
|
|
properties:
|
|
captcha_id:
|
|
description: Captcha ID
|
|
type: string
|
|
type: object
|
|
schema.Job:
|
|
properties:
|
|
created_at:
|
|
type: string
|
|
duty:
|
|
description: 职责
|
|
items:
|
|
type: string
|
|
type: array
|
|
id:
|
|
description: 主键
|
|
type: string
|
|
introduce:
|
|
description: 要求
|
|
type: string
|
|
jobAreaId:
|
|
description: 职位地区id
|
|
type: string
|
|
salary:
|
|
description: 薪资
|
|
type: string
|
|
sequence:
|
|
description: 排序
|
|
type: integer
|
|
status:
|
|
description: 状态
|
|
type: string
|
|
title:
|
|
description: 标题
|
|
type: string
|
|
updated_at:
|
|
type: string
|
|
type: object
|
|
schema.JobArea:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
name:
|
|
description: 区域名字
|
|
type: string
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.JobAreaForm:
|
|
properties:
|
|
name:
|
|
description: Display name of menu // Details about banner
|
|
maxLength: 128
|
|
type: string
|
|
status:
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
required:
|
|
- name
|
|
- status
|
|
type: object
|
|
schema.JobForm:
|
|
properties:
|
|
duty:
|
|
items:
|
|
type: string
|
|
type: array
|
|
introduce:
|
|
type: string
|
|
jobAreaId:
|
|
type: string
|
|
salary:
|
|
description: Details about banner
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
title:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
required:
|
|
- status
|
|
- title
|
|
type: object
|
|
schema.Logger:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
data:
|
|
description: Log data
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
level:
|
|
description: Log level
|
|
type: string
|
|
login_name:
|
|
description: From User.Username
|
|
type: string
|
|
message:
|
|
description: Log message
|
|
type: string
|
|
stack:
|
|
description: Error stack
|
|
type: string
|
|
tag:
|
|
description: Log tag
|
|
type: string
|
|
trace_id:
|
|
description: Trace ID
|
|
type: string
|
|
user_id:
|
|
description: User ID
|
|
type: string
|
|
user_name:
|
|
description: From User.Name
|
|
type: string
|
|
type: object
|
|
schema.LoginForm:
|
|
properties:
|
|
captcha_code:
|
|
description: Captcha verify code
|
|
type: string
|
|
captcha_id:
|
|
description: Captcha verify id
|
|
type: string
|
|
password:
|
|
description: Login password (md5 hash)
|
|
type: string
|
|
username:
|
|
description: Login name
|
|
type: string
|
|
required:
|
|
- password
|
|
- username
|
|
type: object
|
|
schema.LoginToken:
|
|
properties:
|
|
access_token:
|
|
description: Access token (JWT)
|
|
type: string
|
|
expires_at:
|
|
description: 'Expired time (Unit: second)'
|
|
type: integer
|
|
token_type:
|
|
description: 'Token type (Usage: Authorization=${token_type} ${access_token})'
|
|
type: string
|
|
type: object
|
|
schema.Memorabilia:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
month:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: integer
|
|
sequence:
|
|
type: integer
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
title:
|
|
description: Display name of banner
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
year:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: integer
|
|
type: object
|
|
schema.MemorabiliaForm:
|
|
properties:
|
|
month:
|
|
type: integer
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
title:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
year:
|
|
type: integer
|
|
required:
|
|
- status
|
|
- title
|
|
type: object
|
|
schema.Menu:
|
|
properties:
|
|
children:
|
|
description: Child menus
|
|
items:
|
|
$ref: '#/definitions/schema.Menu'
|
|
type: array
|
|
code:
|
|
description: Code of menu (unique for each level)
|
|
type: string
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
description:
|
|
description: Details about menu
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
name:
|
|
description: Display name of menu
|
|
type: string
|
|
parent_id:
|
|
description: Parent ID (From Menu.ID)
|
|
type: string
|
|
parent_path:
|
|
description: Parent path (split by .)
|
|
type: string
|
|
path:
|
|
description: Access path of menu
|
|
type: string
|
|
properties:
|
|
description: Properties of menu (JSON)
|
|
type: string
|
|
resources:
|
|
description: Resources of menu
|
|
items:
|
|
$ref: '#/definitions/schema.MenuResource'
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
type: string
|
|
type:
|
|
description: Type of menu (page, button)
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.MenuForm:
|
|
properties:
|
|
code:
|
|
description: Code of menu (unique for each level)
|
|
maxLength: 32
|
|
type: string
|
|
description:
|
|
description: Details about menu
|
|
type: string
|
|
name:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
parent_id:
|
|
description: Parent ID (From Menu.ID)
|
|
type: string
|
|
path:
|
|
description: Access path of menu
|
|
type: string
|
|
properties:
|
|
description: Properties of menu (JSON)
|
|
type: string
|
|
resources:
|
|
description: Resources of menu
|
|
items:
|
|
$ref: '#/definitions/schema.MenuResource'
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
type:
|
|
description: Type of menu (page, button)
|
|
enum:
|
|
- page
|
|
- button
|
|
type: string
|
|
required:
|
|
- code
|
|
- name
|
|
- status
|
|
- type
|
|
type: object
|
|
schema.MenuResource:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
menu_id:
|
|
description: From Menu.ID
|
|
type: string
|
|
method:
|
|
description: HTTP method
|
|
type: string
|
|
path:
|
|
description: API request path (e.g. /api/v1/users/:id)
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.Product:
|
|
properties:
|
|
categoryID:
|
|
type: integer
|
|
code:
|
|
description: Details about banner
|
|
type: string
|
|
compose:
|
|
type: string
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
feature:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: string
|
|
id:
|
|
type: string
|
|
images:
|
|
items:
|
|
type: string
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
standard:
|
|
items:
|
|
$ref: '#/definitions/schema.ProductStandard'
|
|
type: array
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
target:
|
|
type: string
|
|
title:
|
|
description: Display name of banner
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.ProductCategory:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
type: integer
|
|
label:
|
|
description: Display name of banner
|
|
type: string
|
|
parentID:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
type: integer
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.ProductForm:
|
|
properties:
|
|
categoryID:
|
|
maximum: 11
|
|
type: integer
|
|
code:
|
|
type: string
|
|
compose:
|
|
type: string
|
|
feature:
|
|
type: string
|
|
images:
|
|
items:
|
|
type: string
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
standard:
|
|
description: Details about banner
|
|
items:
|
|
$ref: '#/definitions/schema.ProductStandard'
|
|
type: array
|
|
status:
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
target:
|
|
description: Type of menu (banner, link) // Parent menu``
|
|
type: string
|
|
title:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
required:
|
|
- categoryID
|
|
- status
|
|
- title
|
|
type: object
|
|
schema.ProductStandard:
|
|
properties:
|
|
label:
|
|
type: string
|
|
value:
|
|
type: string
|
|
type: object
|
|
schema.Role:
|
|
properties:
|
|
code:
|
|
description: Code of role (unique)
|
|
type: string
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
description:
|
|
description: Details about role
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
menus:
|
|
description: Role menu list
|
|
items:
|
|
$ref: '#/definitions/schema.RoleMenu'
|
|
type: array
|
|
name:
|
|
description: Display name of role
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting
|
|
type: integer
|
|
status:
|
|
description: Status of role (disabled, enabled)
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.RoleForm:
|
|
properties:
|
|
code:
|
|
description: Code of role (unique)
|
|
maxLength: 32
|
|
type: string
|
|
description:
|
|
description: Details about role
|
|
type: string
|
|
menus:
|
|
description: Role menu list
|
|
items:
|
|
$ref: '#/definitions/schema.RoleMenu'
|
|
type: array
|
|
name:
|
|
description: Display name of role
|
|
maxLength: 128
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting
|
|
type: integer
|
|
status:
|
|
description: Status of role (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
required:
|
|
- code
|
|
- name
|
|
- status
|
|
type: object
|
|
schema.RoleMenu:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
menu_id:
|
|
description: From Menu.ID
|
|
type: string
|
|
role_id:
|
|
description: From Role.ID
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.SocialMedia:
|
|
properties:
|
|
image:
|
|
type: string
|
|
link:
|
|
type: string
|
|
name:
|
|
type: string
|
|
type: object
|
|
schema.Team:
|
|
properties:
|
|
area:
|
|
type: string
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
name:
|
|
description: Display name of banner
|
|
type: string
|
|
rank:
|
|
description: Type of banner (banner, link) // Parent menu``
|
|
items:
|
|
type: string
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
type: object
|
|
schema.TeamForm:
|
|
properties:
|
|
area:
|
|
type: string
|
|
img:
|
|
description: Details about banner
|
|
type: string
|
|
name:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
rank:
|
|
description: Type of banner (ban
|
|
items:
|
|
type: string
|
|
type: array
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
required:
|
|
- name
|
|
- status
|
|
type: object
|
|
schema.UpdateCurrentUser:
|
|
properties:
|
|
email:
|
|
description: Email of user
|
|
maxLength: 128
|
|
type: string
|
|
name:
|
|
description: Name of user
|
|
maxLength: 64
|
|
type: string
|
|
phone:
|
|
description: Phone number of user
|
|
maxLength: 32
|
|
type: string
|
|
remark:
|
|
description: Remark of user
|
|
maxLength: 1024
|
|
type: string
|
|
required:
|
|
- name
|
|
type: object
|
|
schema.UpdateLoginPassword:
|
|
properties:
|
|
new_password:
|
|
description: New password (md5 hash)
|
|
type: string
|
|
old_password:
|
|
description: Old password (md5 hash)
|
|
type: string
|
|
required:
|
|
- new_password
|
|
- old_password
|
|
type: object
|
|
schema.User:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
email:
|
|
description: Email of user
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
name:
|
|
description: Name of user
|
|
type: string
|
|
phone:
|
|
description: Phone number of user
|
|
type: string
|
|
remark:
|
|
description: Remark of user
|
|
type: string
|
|
roles:
|
|
description: Roles of user
|
|
items:
|
|
$ref: '#/definitions/schema.UserRole'
|
|
type: array
|
|
status:
|
|
description: Status of user (activated, freezed)
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
username:
|
|
description: Username for login
|
|
type: string
|
|
type: object
|
|
schema.UserForm:
|
|
properties:
|
|
email:
|
|
description: Email of user
|
|
maxLength: 128
|
|
type: string
|
|
name:
|
|
description: Name of user
|
|
maxLength: 64
|
|
type: string
|
|
password:
|
|
description: Password for login (md5 hash)
|
|
maxLength: 64
|
|
type: string
|
|
phone:
|
|
description: Phone number of user
|
|
maxLength: 32
|
|
type: string
|
|
remark:
|
|
description: Remark of user
|
|
maxLength: 1024
|
|
type: string
|
|
roles:
|
|
description: Roles of user
|
|
items:
|
|
$ref: '#/definitions/schema.UserRole'
|
|
type: array
|
|
status:
|
|
description: Status of user (activated, freezed)
|
|
enum:
|
|
- activated
|
|
- freezed
|
|
type: string
|
|
username:
|
|
description: Username for login
|
|
maxLength: 64
|
|
type: string
|
|
required:
|
|
- name
|
|
- roles
|
|
- status
|
|
- username
|
|
type: object
|
|
schema.UserRole:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
role_id:
|
|
description: From Role.ID
|
|
type: string
|
|
role_name:
|
|
description: From Role.Name
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
user_id:
|
|
description: From User.ID
|
|
type: string
|
|
type: object
|
|
schema.Video:
|
|
properties:
|
|
created_at:
|
|
description: Create time
|
|
type: string
|
|
fullImg:
|
|
description: Details about banner
|
|
type: string
|
|
id:
|
|
description: Unique ID
|
|
type: string
|
|
link:
|
|
type: string
|
|
pushAt:
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
smallImg:
|
|
type: string
|
|
status:
|
|
description: Status of banner (enabled, disabled) // Child menus
|
|
type: string
|
|
subheading:
|
|
description: Display name of banner
|
|
type: string
|
|
title:
|
|
description: Display name of banner
|
|
type: string
|
|
updated_at:
|
|
description: Update time
|
|
type: string
|
|
videoUrl:
|
|
type: string
|
|
type: object
|
|
schema.VideoForm:
|
|
properties:
|
|
fullImg:
|
|
type: string
|
|
link:
|
|
type: string
|
|
pushAt:
|
|
type: string
|
|
sequence:
|
|
description: Sequence for sorting (Order by desc)
|
|
type: integer
|
|
smallImg:
|
|
type: string
|
|
status:
|
|
description: Status of menu (enabled, disabled)
|
|
enum:
|
|
- disabled
|
|
- enabled
|
|
type: string
|
|
title:
|
|
description: Display name of menu
|
|
maxLength: 128
|
|
type: string
|
|
videoUrl:
|
|
type: string
|
|
required:
|
|
- status
|
|
- title
|
|
type: object
|
|
schema.WebJobData:
|
|
properties:
|
|
jobAreaTitle:
|
|
type: string
|
|
jobList:
|
|
items:
|
|
$ref: '#/definitions/schema.Job'
|
|
type: array
|
|
type: object
|
|
schema.WebSite:
|
|
properties:
|
|
address:
|
|
type: string
|
|
affirm:
|
|
type: string
|
|
created_at:
|
|
type: string
|
|
email:
|
|
type: string
|
|
id:
|
|
type: string
|
|
lat:
|
|
type: number
|
|
lon:
|
|
type: number
|
|
phone:
|
|
type: string
|
|
reportContent:
|
|
type: string
|
|
reportImage:
|
|
type: string
|
|
reportNum:
|
|
type: string
|
|
socialMedia:
|
|
items:
|
|
$ref: '#/definitions/schema.SocialMedia'
|
|
type: array
|
|
updated_at:
|
|
type: string
|
|
type: object
|
|
schema.WebSiteForm:
|
|
properties:
|
|
address:
|
|
type: string
|
|
affirm:
|
|
type: string
|
|
email:
|
|
type: string
|
|
lat:
|
|
type: number
|
|
lon:
|
|
type: number
|
|
phone:
|
|
type: string
|
|
reportContent:
|
|
type: string
|
|
reportImage:
|
|
type: string
|
|
reportNum:
|
|
type: string
|
|
socialMedia:
|
|
items:
|
|
$ref: '#/definitions/schema.SocialMedia'
|
|
type: array
|
|
type: object
|
|
util.ResponseResult:
|
|
properties:
|
|
data: {}
|
|
error:
|
|
$ref: '#/definitions/errors.Error'
|
|
success:
|
|
type: boolean
|
|
total:
|
|
type: integer
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
description: Hailinservice API service
|
|
title: hailinservice
|
|
version: v1.0.0
|
|
paths:
|
|
/api/v1/articles:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: name of Article
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Article'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Article list
|
|
tags:
|
|
- ArticleAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.ArticleForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Article'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create Article record
|
|
tags:
|
|
- ArticleAPI
|
|
/api/v1/articles/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Article record by ID
|
|
tags:
|
|
- ArticleAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Article'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Article record by ID
|
|
tags:
|
|
- ArticleAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.ArticleForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Article record by ID
|
|
tags:
|
|
- ArticleAPI
|
|
/api/v1/banners:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: Name of banner
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Banner'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query banner list
|
|
tags:
|
|
- BannerAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.BannerForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Banner'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create banner record
|
|
tags:
|
|
- BannerAPI
|
|
/api/v1/banners/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete banner record by ID
|
|
tags:
|
|
- BannerAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Banner'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get banner record by ID
|
|
tags:
|
|
- BannerAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.BannerForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update banner record by ID
|
|
tags:
|
|
- BannerAPI
|
|
/api/v1/captcha/id:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Captcha'
|
|
type: object
|
|
summary: Get captcha ID
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/captcha/image:
|
|
get:
|
|
parameters:
|
|
- description: Captcha ID
|
|
in: query
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Reload captcha image (reload=1)
|
|
in: query
|
|
name: reload
|
|
type: number
|
|
produces:
|
|
- image/png
|
|
responses:
|
|
"200":
|
|
description: Captcha image
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
summary: Response captcha image
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/current/logout:
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Logout system
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/current/menus:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Menu'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query current user menus based on the current user role
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/current/password:
|
|
put:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.UpdateLoginPassword'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Change current user password
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/current/refresh-token:
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.LoginToken'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Refresh current access token
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/current/user:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.User'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get current user info
|
|
tags:
|
|
- LoginAPI
|
|
put:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.UpdateCurrentUser'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update current user info
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/jobs:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: title of Job
|
|
in: query
|
|
name: title
|
|
type: string
|
|
- description: jobAreaId of Job
|
|
in: query
|
|
name: jobAreaId
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Job'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Job list
|
|
tags:
|
|
- 职位模块
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.JobForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Job'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create Job record
|
|
tags:
|
|
- 职位模块
|
|
/api/v1/jobs/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Job record by ID
|
|
tags:
|
|
- 职位模块
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Job'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Job record by ID
|
|
tags:
|
|
- 职位模块
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.JobForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Job record by ID
|
|
tags:
|
|
- 职位模块
|
|
/api/v1/jobs/job_areas:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.JobArea'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query JobArea list
|
|
tags:
|
|
- 职位模块
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.JobAreaForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.JobAreaForm'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create JobArea record
|
|
tags:
|
|
- 职位模块
|
|
/api/v1/jobs/job_areas/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete JobArea record by ID
|
|
tags:
|
|
- 职位模块
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.JobAreaForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update JobArea record by ID
|
|
tags:
|
|
- 职位模块
|
|
/api/v1/loggers:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: log level
|
|
in: query
|
|
name: level
|
|
type: string
|
|
- description: trace ID
|
|
in: query
|
|
name: traceID
|
|
type: string
|
|
- description: user name
|
|
in: query
|
|
name: userName
|
|
type: string
|
|
- description: log tag
|
|
in: query
|
|
name: tag
|
|
type: string
|
|
- description: log message
|
|
in: query
|
|
name: message
|
|
type: string
|
|
- description: start time
|
|
in: query
|
|
name: startTime
|
|
type: string
|
|
- description: end time
|
|
in: query
|
|
name: endTime
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Logger'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query logger list
|
|
tags:
|
|
- LoggerAPI
|
|
/api/v1/login:
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.LoginForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.LoginToken'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
summary: Login system with username and password
|
|
tags:
|
|
- LoginAPI
|
|
/api/v1/memorabilias:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: title of Memorabilia
|
|
in: query
|
|
name: title
|
|
type: string
|
|
- description: month of Memorabilia
|
|
in: query
|
|
name: month
|
|
type: string
|
|
- description: year of Memorabilia
|
|
in: query
|
|
name: year
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Memorabilia'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Memorabilia list
|
|
tags:
|
|
- 发展历程模块
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.MemorabiliaForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Memorabilia'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create Article record
|
|
tags:
|
|
- 发展历程模块
|
|
/api/v1/memorabilias/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Article record by ID
|
|
tags:
|
|
- 发展历程模块
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Memorabilia'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Memorabilia record by ID
|
|
tags:
|
|
- 发展历程模块
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.MemorabiliaForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Article record by ID
|
|
tags:
|
|
- 发展历程模块
|
|
/api/v1/menus:
|
|
get:
|
|
parameters:
|
|
- description: Code path of menu (like xxx.xxx.xxx)
|
|
in: query
|
|
name: code
|
|
type: string
|
|
- description: Name of menu
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Whether to include menu resources
|
|
in: query
|
|
name: includeResources
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Menu'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query menu tree data
|
|
tags:
|
|
- MenuAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.MenuForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Menu'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create menu record
|
|
tags:
|
|
- MenuAPI
|
|
/api/v1/menus/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete menu record by ID
|
|
tags:
|
|
- MenuAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Menu'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get menu record by ID
|
|
tags:
|
|
- MenuAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.MenuForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update menu record by ID
|
|
tags:
|
|
- MenuAPI
|
|
/api/v1/products:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: title of Product
|
|
in: query
|
|
name: title
|
|
type: string
|
|
- description: categoryId of Product
|
|
in: query
|
|
name: categoryId
|
|
type: integer
|
|
- description: code of Product
|
|
in: query
|
|
name: code
|
|
type: string
|
|
- description: Status of Product (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Product'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Product list
|
|
tags:
|
|
- 产品模块
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.ProductForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Product'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create Product record
|
|
tags:
|
|
- 产品模块
|
|
/api/v1/products/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Product record by ID
|
|
tags:
|
|
- 产品模块
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Product'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Product record by ID
|
|
tags:
|
|
- 产品模块
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.ProductForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Product record by ID
|
|
tags:
|
|
- 产品模块
|
|
/api/v1/products/categorys:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.ProductCategory'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query ProductCategory list
|
|
tags:
|
|
- 产品模块
|
|
/api/v1/roles:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: Display name of role
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Status of role (disabled, enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Role'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query role list
|
|
tags:
|
|
- RoleAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.RoleForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Role'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create role record
|
|
tags:
|
|
- RoleAPI
|
|
/api/v1/roles/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete role record by ID
|
|
tags:
|
|
- RoleAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Role'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get role record by ID
|
|
tags:
|
|
- RoleAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.RoleForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update role record by ID
|
|
tags:
|
|
- RoleAPI
|
|
/api/v1/teams:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: name of Team
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Team'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Team list
|
|
tags:
|
|
- 团队模块
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.TeamForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Team'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create Article record
|
|
tags:
|
|
- 团队模块
|
|
/api/v1/teams/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Article record by ID
|
|
tags:
|
|
- 团队模块
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Team'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Team record by ID
|
|
tags:
|
|
- 团队模块
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.TeamForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Article record by ID
|
|
tags:
|
|
- 团队模块
|
|
/api/v1/users:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: Username for login
|
|
in: query
|
|
name: username
|
|
type: string
|
|
- description: Name of user
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Status of user (activated, freezed)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.User'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query user list
|
|
tags:
|
|
- UserAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.UserForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.User'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create user record
|
|
tags:
|
|
- UserAPI
|
|
/api/v1/users/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete user record by ID
|
|
tags:
|
|
- UserAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.User'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get user record by ID
|
|
tags:
|
|
- UserAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.UserForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update user record by ID
|
|
tags:
|
|
- UserAPI
|
|
/api/v1/users/{id}/reset-pwd:
|
|
patch:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Reset user password by ID
|
|
tags:
|
|
- UserAPI
|
|
/api/v1/videos:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: title of Video
|
|
in: query
|
|
name: title
|
|
type: string
|
|
- description: Status of banner (disabled,enabled)
|
|
in: query
|
|
name: status
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Video'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query Video list
|
|
tags:
|
|
- VideoAPI
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.VideoForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Video'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create banner record
|
|
tags:
|
|
- VideoAPI
|
|
/api/v1/videos/{id}:
|
|
delete:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Delete Video record by ID
|
|
tags:
|
|
- VideoAPI
|
|
get:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.Video'
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get Video record by ID
|
|
tags:
|
|
- VideoAPI
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.BannerForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update Video record by ID
|
|
tags:
|
|
- VideoAPI
|
|
/api/v1/web/articles:
|
|
get:
|
|
parameters:
|
|
- default: 1
|
|
description: pagination index
|
|
in: query
|
|
name: current
|
|
required: true
|
|
type: integer
|
|
- default: 10
|
|
description: pagination size
|
|
in: query
|
|
name: pageSize
|
|
required: true
|
|
type: integer
|
|
- description: jobAreaId of Job
|
|
in: query
|
|
name: jobAreaId
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.Article'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: 获取公司动态
|
|
tags:
|
|
- 网页模块
|
|
/api/v1/web/jobs:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.WebJobData'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: 获取职位列表
|
|
tags:
|
|
- 网页模块
|
|
/api/v1/web_site:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
items:
|
|
$ref: '#/definitions/schema.WebSite'
|
|
type: array
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Query WebSite info
|
|
tags:
|
|
- 网页设置
|
|
post:
|
|
parameters:
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.WebSiteForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/util.ResponseResult'
|
|
- properties:
|
|
data:
|
|
$ref: '#/definitions/schema.WebSite'
|
|
type: object
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Create WebSite record
|
|
tags:
|
|
- ArticleAPI
|
|
/api/v1/web_site/{id}:
|
|
put:
|
|
parameters:
|
|
- description: unique id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Request body
|
|
in: body
|
|
name: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/schema.WebSiteForm'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/util.ResponseResult'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Update WebSite record by ID
|
|
tags:
|
|
- 网页设置
|
|
securityDefinitions:
|
|
ApiKeyAuth:
|
|
in: header
|
|
name: Authorization
|
|
type: apiKey
|
|
swagger: "2.0"
|