瀏覽代碼

update swag

master
shenjiachi 1 周之前
父節點
當前提交
891c11608f
共有 3 個文件被更改,包括 1249 次插入0 次删除
  1. +466
    -0
      docs/docs.go
  2. +466
    -0
      docs/swagger.json
  3. +317
    -0
      docs/swagger.yaml

+ 466
- 0
docs/docs.go 查看文件

@@ -6371,6 +6371,157 @@ const docTemplate = `{
}
}
},
"/api/notice/aliyunSms/getLevelList": {
"get": {
"description": "等级管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-等级管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.AliyunSmsGetLevelListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/getTagList": {
"get": {
"description": "标签管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-标签管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.AliyunSmsGetTagListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/getUserList": {
"post": {
"description": "获取用户信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-获取用户信息",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "(分页信息必填)",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.JPushGetUserListReq"
}
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"type": "Object"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/push/list": {
"post": {
"description": "短信推送记录-推送记录列表",
@@ -6691,6 +6842,157 @@ const docTemplate = `{
}
}
},
"/api/notice/jPush/getLevelList": {
"get": {
"description": "等级管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-等级管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.JPushGetLevelListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/getTagList": {
"get": {
"description": "标签管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-标签管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.JPushGetTagListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/getUserList": {
"post": {
"description": "获取用户信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-获取用户信息",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "(分页信息必填)",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.JPushGetUserListReq"
}
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"type": "Object"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/push/list": {
"post": {
"description": "基本配置-推送记录列表",
@@ -8231,6 +8533,23 @@ const docTemplate = `{
}
},
"definitions": {
"applet_app_md.Paginate": {
"type": "object",
"properties": {
"limit": {
"description": "每页大小",
"type": "integer"
},
"page": {
"description": "页数",
"type": "integer"
},
"total": {
"description": "总数据量",
"type": "integer"
}
}
},
"applet_app_md_financial_center.Paginate": {
"type": "object",
"properties": {
@@ -9223,6 +9542,34 @@ const docTemplate = `{
}
}
},
"md.AliyunSmsGetLevelListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.LevelListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.AliyunSmsGetTagListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.TagListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.ArticleCateDelReq": {
"type": "object",
"properties": {
@@ -11847,6 +12194,125 @@ const docTemplate = `{
}
}
},
"md.JPushGetLevelListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.LevelListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.JPushGetTagListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.TagListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.JPushGetUserListReq": {
"type": "object",
"properties": {
"effective": {
"description": "有效会员",
"type": "integer"
},
"id": {
"description": "会员 ID",
"type": "integer"
},
"invite_code": {
"type": "string",
"example": "会员邀请码"
},
"is_real_name": {
"description": "是否实名 0.未实名,1.已实名",
"type": "integer"
},
"level": {
"description": "会员等级",
"type": "integer"
},
"limit": {
"type": "integer"
},
"login_after": {
"description": "最近登录结束时间",
"type": "string"
},
"login_before": {
"description": "最近登录开始时间",
"type": "string"
},
"memo": {
"description": "备注",
"type": "string"
},
"nickname": {
"type": "string",
"example": "会员昵称"
},
"page": {
"type": "integer"
},
"parent_invite_code": {
"type": "string",
"example": "上级邀请码"
},
"parent_phone": {
"type": "string",
"example": "上级手机号"
},
"phone": {
"type": "string",
"example": "会员手机号"
},
"recommend_id": {
"description": "推荐人 ID",
"type": "integer"
},
"register_after": {
"description": "注册时间终点",
"type": "string"
},
"register_before": {
"description": "注册时间起点",
"type": "string"
},
"register_type": {
"description": "注册类型(1:APP注册、2:H5注册)",
"type": "integer"
},
"sex": {
"description": "性别(0:未知 1:男 2:女)",
"type": "integer"
},
"state": {
"description": "状态",
"type": "integer"
},
"tag": {
"description": "标签 id",
"type": "integer"
},
"union_id": {
"type": "string",
"example": "微信号"
}
}
},
"md.LevelListNode": {
"type": "object",
"properties": {


+ 466
- 0
docs/swagger.json 查看文件

@@ -6364,6 +6364,157 @@
}
}
},
"/api/notice/aliyunSms/getLevelList": {
"get": {
"description": "等级管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-等级管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.AliyunSmsGetLevelListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/getTagList": {
"get": {
"description": "标签管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-标签管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.AliyunSmsGetTagListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/getUserList": {
"post": {
"description": "获取用户信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-短信推送记录-获取用户信息",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "(分页信息必填)",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.JPushGetUserListReq"
}
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"type": "Object"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/aliyunSms/push/list": {
"post": {
"description": "短信推送记录-推送记录列表",
@@ -6684,6 +6835,157 @@
}
}
},
"/api/notice/jPush/getLevelList": {
"get": {
"description": "等级管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-等级管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.JPushGetLevelListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/getTagList": {
"get": {
"description": "标签管理(获取)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-标签管理(获取)",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"type": "integer",
"description": "每页大小",
"name": "limit",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "页数",
"name": "page",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"$ref": "#/definitions/md.JPushGetTagListResp"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/getUserList": {
"post": {
"description": "获取用户信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息中心"
],
"summary": "消息中心-基本配置-获取用户信息",
"parameters": [
{
"type": "string",
"description": "验证参数Bearer和token空格拼接",
"name": "Authorization",
"in": "header",
"required": true
},
{
"description": "(分页信息必填)",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/md.JPushGetUserListReq"
}
}
],
"responses": {
"200": {
"description": "具体数据",
"schema": {
"type": "Object"
}
},
"400": {
"description": "具体错误",
"schema": {
"$ref": "#/definitions/md.Response"
}
}
}
}
},
"/api/notice/jPush/push/list": {
"post": {
"description": "基本配置-推送记录列表",
@@ -8224,6 +8526,23 @@
}
},
"definitions": {
"applet_app_md.Paginate": {
"type": "object",
"properties": {
"limit": {
"description": "每页大小",
"type": "integer"
},
"page": {
"description": "页数",
"type": "integer"
},
"total": {
"description": "总数据量",
"type": "integer"
}
}
},
"applet_app_md_financial_center.Paginate": {
"type": "object",
"properties": {
@@ -9216,6 +9535,34 @@
}
}
},
"md.AliyunSmsGetLevelListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.LevelListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.AliyunSmsGetTagListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.TagListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.ArticleCateDelReq": {
"type": "object",
"properties": {
@@ -11840,6 +12187,125 @@
}
}
},
"md.JPushGetLevelListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.LevelListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.JPushGetTagListResp": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/md.TagListNode"
}
},
"paginate": {
"$ref": "#/definitions/applet_app_md.Paginate"
}
}
},
"md.JPushGetUserListReq": {
"type": "object",
"properties": {
"effective": {
"description": "有效会员",
"type": "integer"
},
"id": {
"description": "会员 ID",
"type": "integer"
},
"invite_code": {
"type": "string",
"example": "会员邀请码"
},
"is_real_name": {
"description": "是否实名 0.未实名,1.已实名",
"type": "integer"
},
"level": {
"description": "会员等级",
"type": "integer"
},
"limit": {
"type": "integer"
},
"login_after": {
"description": "最近登录结束时间",
"type": "string"
},
"login_before": {
"description": "最近登录开始时间",
"type": "string"
},
"memo": {
"description": "备注",
"type": "string"
},
"nickname": {
"type": "string",
"example": "会员昵称"
},
"page": {
"type": "integer"
},
"parent_invite_code": {
"type": "string",
"example": "上级邀请码"
},
"parent_phone": {
"type": "string",
"example": "上级手机号"
},
"phone": {
"type": "string",
"example": "会员手机号"
},
"recommend_id": {
"description": "推荐人 ID",
"type": "integer"
},
"register_after": {
"description": "注册时间终点",
"type": "string"
},
"register_before": {
"description": "注册时间起点",
"type": "string"
},
"register_type": {
"description": "注册类型(1:APP注册、2:H5注册)",
"type": "integer"
},
"sex": {
"description": "性别(0:未知 1:男 2:女)",
"type": "integer"
},
"state": {
"description": "状态",
"type": "integer"
},
"tag": {
"description": "标签 id",
"type": "integer"
},
"union_id": {
"type": "string",
"example": "微信号"
}
}
},
"md.LevelListNode": {
"type": "object",
"properties": {


+ 317
- 0
docs/swagger.yaml 查看文件

@@ -1,4 +1,16 @@
definitions:
applet_app_md.Paginate:
properties:
limit:
description: 每页大小
type: integer
page:
description: 页数
type: integer
total:
description: 总数据量
type: integer
type: object
applet_app_md_financial_center.Paginate:
properties:
limit:
@@ -693,6 +705,24 @@ definitions:
example: 名称
type: string
type: object
md.AliyunSmsGetLevelListResp:
properties:
list:
items:
$ref: '#/definitions/md.LevelListNode'
type: array
paginate:
$ref: '#/definitions/applet_app_md.Paginate'
type: object
md.AliyunSmsGetTagListResp:
properties:
list:
items:
$ref: '#/definitions/md.TagListNode'
type: array
paginate:
$ref: '#/definitions/applet_app_md.Paginate'
type: object
md.ArticleCateDelReq:
properties:
id:
@@ -2501,6 +2531,91 @@ definitions:
content_image_url:
type: string
type: object
md.JPushGetLevelListResp:
properties:
list:
items:
$ref: '#/definitions/md.LevelListNode'
type: array
paginate:
$ref: '#/definitions/applet_app_md.Paginate'
type: object
md.JPushGetTagListResp:
properties:
list:
items:
$ref: '#/definitions/md.TagListNode'
type: array
paginate:
$ref: '#/definitions/applet_app_md.Paginate'
type: object
md.JPushGetUserListReq:
properties:
effective:
description: 有效会员
type: integer
id:
description: 会员 ID
type: integer
invite_code:
example: 会员邀请码
type: string
is_real_name:
description: 是否实名 0.未实名,1.已实名
type: integer
level:
description: 会员等级
type: integer
limit:
type: integer
login_after:
description: 最近登录结束时间
type: string
login_before:
description: 最近登录开始时间
type: string
memo:
description: 备注
type: string
nickname:
example: 会员昵称
type: string
page:
type: integer
parent_invite_code:
example: 上级邀请码
type: string
parent_phone:
example: 上级手机号
type: string
phone:
example: 会员手机号
type: string
recommend_id:
description: 推荐人 ID
type: integer
register_after:
description: 注册时间终点
type: string
register_before:
description: 注册时间起点
type: string
register_type:
description: 注册类型(1:APP注册、2:H5注册)
type: integer
sex:
description: 性别(0:未知 1:男 2:女)
type: integer
state:
description: 状态
type: integer
tag:
description: 标签 id
type: integer
union_id:
example: 微信号
type: string
type: object
md.LevelListNode:
properties:
count:
@@ -9160,6 +9275,107 @@ paths:
summary: 消息中心-短信推送记录-通知模板
tags:
- 消息中心
/api/notice/aliyunSms/getLevelList:
get:
consumes:
- application/json
description: 等级管理(获取)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 每页大小
in: query
name: limit
required: true
type: integer
- description: 页数
in: query
name: page
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
$ref: '#/definitions/md.AliyunSmsGetLevelListResp'
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-短信推送记录-等级管理(获取)
tags:
- 消息中心
/api/notice/aliyunSms/getTagList:
get:
consumes:
- application/json
description: 标签管理(获取)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 每页大小
in: query
name: limit
required: true
type: integer
- description: 页数
in: query
name: page
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
$ref: '#/definitions/md.AliyunSmsGetTagListResp'
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-短信推送记录-标签管理(获取)
tags:
- 消息中心
/api/notice/aliyunSms/getUserList:
post:
consumes:
- application/json
description: 获取用户信息
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: (分页信息必填)
in: body
name: req
required: true
schema:
$ref: '#/definitions/md.JPushGetUserListReq'
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
type: Object
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-短信推送记录-获取用户信息
tags:
- 消息中心
/api/notice/aliyunSms/push/list:
post:
consumes:
@@ -9371,6 +9587,107 @@ paths:
summary: 消息中心-基本配置-通知模板添加编辑
tags:
- 消息中心
/api/notice/jPush/getLevelList:
get:
consumes:
- application/json
description: 等级管理(获取)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 每页大小
in: query
name: limit
required: true
type: integer
- description: 页数
in: query
name: page
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
$ref: '#/definitions/md.JPushGetLevelListResp'
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-基本配置-等级管理(获取)
tags:
- 消息中心
/api/notice/jPush/getTagList:
get:
consumes:
- application/json
description: 标签管理(获取)
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: 每页大小
in: query
name: limit
required: true
type: integer
- description: 页数
in: query
name: page
required: true
type: integer
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
$ref: '#/definitions/md.JPushGetTagListResp'
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-基本配置-标签管理(获取)
tags:
- 消息中心
/api/notice/jPush/getUserList:
post:
consumes:
- application/json
description: 获取用户信息
parameters:
- description: 验证参数Bearer和token空格拼接
in: header
name: Authorization
required: true
type: string
- description: (分页信息必填)
in: body
name: req
required: true
schema:
$ref: '#/definitions/md.JPushGetUserListReq'
produces:
- application/json
responses:
"200":
description: 具体数据
schema:
type: Object
"400":
description: 具体错误
schema:
$ref: '#/definitions/md.Response'
summary: 消息中心-基本配置-获取用户信息
tags:
- 消息中心
/api/notice/jPush/push/list:
post:
consumes:


Loading…
取消
儲存