Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2023-08-14 12:03:39 | 2023-08-14 12:03:39 | auto | @root | Created by smart-doc |
1. default
2. 基础-admin
2.1. 用户权限
2.1.1. 用户菜单
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户菜单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─name | string | 名称 | - |
└─path | string | 路径 | - |
└─component | string | 组件 | - |
└─isLink | boolean | 是否链接 | - |
└─meta | object | 元数据 | - |
└─title | string | 标题 | - |
└─icon | string | 图标 | - |
└─isHide | boolean | 是否隐藏 | - |
└─isKeepAlive | boolean | 是否保持 | - |
└─isAffix | boolean | 是否固定 | - |
└─isIframe | boolean | 是否iframe | - |
Response-example:
{
"code": 725,
"message": "success",
"data": [
{
"id": 620,
"parentId": 728,
"label": "1p9krd",
"isShow": true,
"isChecked": true,
"sortNum": 992,
"children": [
{
"object": "any object"
}
],
"name": "kyong.mayert",
"path": "lpq2hw",
"component": "5tw9lm",
"isLink": true,
"meta": {
"title": "rokyty",
"icon": "e53kzi",
"isHide": true,
"isKeepAlive": true,
"isAffix": true,
"isIframe": true
}
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/permission/menus
2.2. 附件管理
2.2.1. 附件列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 附件列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
fileType | string | false | No comments found. | ||
fileName | string | false | 文件名称模糊搜索 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | 上传人id | - |
└─fileName | string | 原始文件名 | - |
└─fileDesc | string | 文件描述 | - |
└─filePath | string | 文件相对路径 | - |
└─fileType | string | 文件类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─fileSize | string | 文件大小 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 10,
"message": "success",
"data": {
"total": 38,
"pages": 429,
"records": [
{
"id": 60,
"createUserId": 742,
"fileName": "kyong.mayert",
"fileDesc": "ws3j0t",
"filePath": "i1okat",
"fileType": "3luy0m",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"fileSize": "tjjrxq"
}
],
"current": 865,
"size": 135,
"orders": [
{
"column": "z6hlc9",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 49
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/attachment/list?pageSize=909&fileType=9h7uck&pageNum=493&fileName=kyong.mayert
2.2.2. 上传附件
Type: POST
Content-Type: multipart/form-data
Description: 上传附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
files | file | true | 待上传文件(array of file) |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 911,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/attachment/upload
2.2.3. 修改附件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 修改附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
fileName | string | true | 附件名称 | ||
fileDesc | string | false | 附件描述 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 950,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/attachment/update/594 --data 'fileName=kyong.mayert&fileDesc=9zdk6g'
2.2.4. 附件明细
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 附件明细
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | 上传人id | - |
└─fileName | string | 原始文件名 | - |
└─fileDesc | string | 文件描述 | - |
└─filePath | string | 文件相对路径 | - |
└─fileType | string | 文件类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─fileSize | string | 文件大小 | - |
Response-example:
{
"code": 465,
"message": "success",
"data": {
"id": 448,
"createUserId": 533,
"fileName": "kyong.mayert",
"fileDesc": "262e29",
"filePath": "psgcv5",
"fileType": "ofllmg",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"fileSize": "wb0i04"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/attachment/get/908
2.2.5. 删除附件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 104,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/attachment/delete/111
2.3. 订单管理
2.3.1. 订单列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 订单列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
orderSn | string | false | 订单号 | ||
title | string | false | 商品标题 | ||
payStatus | string | false | 支付状态 | ||
tradeStatus | string | false | No comments found. | ||
status | string | false | 订单状态 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int32 | 订单id | - |
└─orderSn | string | 订单编号 | - |
└─title | string | 商品名称 | - |
└─status | int32 | 订单状态 | - |
└─statusStr | string | 订单状态 | - |
└─payStatus | int32 | 支付状态 | - |
└─payStatusStr | string | 支付状态显示值 | - |
└─userName | string | 买家账号 | - |
└─nickName | string | 买家昵称 | - |
└─productCount | int32 | 商品数量 | - |
└─totalAmount | number | 商品金额 | - |
└─payAmount | number | 支付金额 | - |
└─thumbnail | string | 商品缩略图 | - |
└─created | string | 创建时间 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 538,
"message": "success",
"data": {
"total": 27,
"pages": 823,
"records": [
{
"id": 749,
"orderSn": "7roc4q",
"title": "fkjgrh",
"status": 681,
"statusStr": "bgc6rl",
"payStatus": 708,
"payStatusStr": "ot1q0e",
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"productCount": 596,
"totalAmount": 182,
"payAmount": 21,
"thumbnail": "f2i0h7",
"created": "2023-08-14"
}
],
"current": 664,
"size": 307,
"orders": [
{
"column": "t8t195",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 397
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/list?status=kmiwoa&tradeStatus=4j62sx&pageNum=785&title=04godp&orderSn=rf880l&payStatus=oui2b3&pageSize=698
2.3.2. 订单详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 订单详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | 订单号 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─orderSn | string | 订单号 | - |
└─createUserId | int64 | 购买人 | - |
└─orderTitle | string | No comments found. | - |
└─buyerMsg | string | 用户留言 | - |
└─orderAmount | number | 订单商品金额之和 | - |
└─payStatus | int32 | 支付状态 | - |
└─deliveryId | int64 | 发货情况 | - |
└─deliveryStatus | int32 | 1待发货,2已发货 | - |
└─consigneeUsername | string | 收货人地址 | - |
└─consigneeMobile | string | 收货人手机号(电话) | - |
└─consigneeAddrDetail | string | 收件人的详细地址 | - |
└─invoiceId | int32 | 发票 | - |
└─invoiceStatus | int32 | 发票开具状态:1 未申请发票、 2 发票申请中、 3 发票开具中、 4 无需开具发票、 5发票已经开具 | - |
└─postageAmount | number | 订单邮费 | - |
└─payAmount | number | 支付金额,商品金额 + 邮费 - 优惠或减免金额 | - |
└─remarks | string | 管理员后台备注 | - |
└─tradeStatus | int32 | 交易状态:1交易中、 2交易完成(但是可以申请退款) 、3取消交易 、4申请退款、 5拒绝退款、 6退款中、 7退款完成、 8交易结束 | - |
└─version | int32 | No comments found. | - |
└─jsonExt | string | json格式扩展字段 | - |
└─status | int32 | 删除状态:1 正常 ,0 已经删除 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─orderItemList | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─orderId | int64 | 订单id | - |
└─orderSn | string | 订单号 | - |
└─sellerId | int64 | 卖家id | - |
└─productId | int64 | 产品id | - |
└─productType | string | 产品类型 | - |
└─productCount | int32 | 产品数量 | - |
└─postageCost | number | 邮费 | - |
└─totalAmount | number | 具体金额 = 产品价格+运费+其他价格 | - |
└─updated | string | 修改时间 | - |
└─created | string | 创建时间 | - |
└─productTitle | string | 商品名称 | - |
└─productThumbnail | string | 商品缩略图 | - |
└─nickName | string | 买家昵称 | - |
└─userName | string | 买家账号 | - |
Response-example:
{
"code": 985,
"message": "success",
"data": {
"id": 711,
"orderSn": "03n48w",
"createUserId": 709,
"orderTitle": "dolyyo",
"buyerMsg": "xijes4",
"orderAmount": 678,
"payStatus": 12,
"deliveryId": 78,
"deliveryStatus": 741,
"consigneeUsername": "kyong.mayert",
"consigneeMobile": "(816) 208-8500",
"consigneeAddrDetail": "7xc0zr",
"invoiceId": 416,
"invoiceStatus": 377,
"postageAmount": 299,
"payAmount": 129,
"remarks": "7blgwb",
"tradeStatus": 227,
"version": 835,
"jsonExt": "gd2vl1",
"status": 366,
"created": "2023-08-14 12:03:45",
"updated": "2023-08-14 12:03:45",
"orderItemList": [
{
"id": 525,
"orderId": 215,
"orderSn": "za3jb6",
"sellerId": 959,
"productId": 696,
"productType": "ef7aa8",
"productCount": 797,
"postageCost": 991,
"totalAmount": 272,
"updated": "2023-08-14 12:03:45",
"created": "2023-08-14 12:03:45",
"productTitle": "grl0tm",
"productThumbnail": "eji9al"
}
],
"nickName": "damian.botsford",
"userName": "kyong.mayert"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/detail/255
2.3.3. 删除订单
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除订单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 235,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/delete/303
2.3.4. 提现管理
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 提现管理
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
userName | string | false | No comments found. | ||
status | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | id | - |
└─nickName | string | 提现用户 | - |
└─realName | string | 真实姓名 | - |
└─amount | number | 提现金额 | - |
└─payFee | number | 手续费 | - |
└─payType | int32 | 提现类型 | - |
└─auditType | int32 | 审核类型 | - |
└─payTo | string | 支付账号 | - |
└─status | int32 | 状态 | - |
└─created | string | 提现时间 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 665,
"message": "success",
"data": {
"total": 557,
"pages": 12,
"records": [
{
"id": 387,
"nickName": "damian.botsford",
"realName": "kyong.mayert",
"amount": 633,
"payFee": 667,
"payType": 836,
"auditType": 570,
"payTo": "0zi1ek",
"status": 355,
"created": "2023-08-14 12:03:45"
}
],
"current": 731,
"size": 987,
"orders": [
{
"column": "5bkzxa",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 306
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/cashout/list?userName=kyong.mayert&status=fzppm4&pageSize=931&pageNum=693
2.3.5. 提现单详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 提现单详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
payoutId | int64 | true | 提现单号 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | id | - |
└─nickName | string | 提现用户 | - |
└─realName | string | 真实姓名 | - |
└─amount | number | 提现金额 | - |
└─payFee | number | 手续费 | - |
└─payType | int32 | 提现类型 | - |
└─auditType | int32 | 审核类型 | - |
└─payTo | string | 支付账号 | - |
└─status | int32 | 状态 | - |
└─created | string | 提现时间 | - |
└─userId | int64 | 提现用户 | - |
└─feedback | string | 拒绝理由 | - |
└─userAmountStatementList | array | 用户收入流水 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | 用户 | - |
└─action | string | 金额变动方向 add, del | - |
└─actionType | int32 | 余额变动业务类型 | - |
└─actionDesc | string | 金额变动描述 | - |
└─actionOrderId | int64 | 相关的订单ID | - |
└─actionPaymentId | int64 | 相关的支付ID | - |
└─oldAmount | number | 用户之前的余额 | - |
└─changeAmount | number | 变动金额 | - |
└─newAmount | number | 变动之后的余额 | - |
└─created | string | 创建时间 | - |
└─actionName | string | 金额变动名称 增加,减少 | - |
└─actionTypeName | string | 余额变动业务类型名称 | - |
Response-example:
{
"code": 863,
"message": "success",
"data": {
"id": 443,
"nickName": "damian.botsford",
"realName": "kyong.mayert",
"amount": 503,
"payFee": 85,
"payType": 526,
"auditType": 67,
"payTo": "gn7u8h",
"status": 78,
"created": "2023-08-14 12:03:45",
"userId": 965,
"feedback": "cd681m",
"userAmountStatementList": [
{
"id": 898,
"createUserId": 57,
"action": "xcgaj4",
"actionType": 622,
"actionDesc": "2wjufu",
"actionOrderId": 722,
"actionPaymentId": 413,
"oldAmount": 456,
"changeAmount": 500,
"newAmount": 864,
"created": "2023-08-14 12:03:45",
"actionName": "kyong.mayert",
"actionTypeName": "kyong.mayert"
}
]
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/cashout/detail/559
2.3.6. 确认提现单
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 确认提现单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
payoutId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 440,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/cashout/confirm/37
2.3.7. 拒绝提现单
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 拒绝提现单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
payoutId | int64 | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
feedback | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 51,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/cashout/refuse/623 --data 'feedback=ol8ffd'
2.3.8. 支付记录
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 支付记录
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
trxNo | string | false | No comments found. | ||
userName | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | 支付记录id | - |
└─trxNo | string | 支付流水号 | - |
└─payAmount | number | 支付金额 | - |
└─prodTitle | string | 关联产品 | - |
└─userName | string | 支付用户 | - |
└─nickName | string | 支付用户 | - |
└─payType | string | 支付类型 | - |
└─created | string | 支付时间 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 297,
"message": "success",
"data": {
"total": 798,
"pages": 266,
"records": [
{
"id": 642,
"trxNo": "5amfnl",
"payAmount": 993,
"prodTitle": "iryeuz",
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"payType": "v33dmx",
"created": "2023-08-14 12:03:45"
}
],
"current": 675,
"size": 501,
"orders": [
{
"column": "bb5ily",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 131
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/payment/list?trxNo=3sy4h3&userName=kyong.mayert&pageNum=772&pageSize=511
2.3.9. 支付记录详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 支付记录详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
paymentId | int64 | true | 订单号 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | 支付记录id | - |
└─trxNo | string | 支付流水号 | - |
└─payAmount | number | 订单金额 | - |
└─prodTitle | string | 关联产品 | - |
└─userName | string | 支付用户 | - |
└─nickName | string | 支付用户 | - |
└─payType | string | 支付类型 | - |
└─created | string | 支付时间 | - |
└─payStatus | int32 | 支付状态:0生成订单未支付(预支付)、1支付成功、 2支付失败 | - |
└─payBankType | string | 支付银行类型 | - |
└─paySuccessAmount | number | 成功支付金额 | - |
└─paySuccessTime | string | 支付成功时间 | - |
└─thirdpartyType | string | 第三方支付平台 | - |
└─thirdpartyAppid | string | 微信appid 或者 支付宝的appid,thirdparty 指的是支付的第三方比如微信、支付宝、PayPal等 | - |
└─thirdpartyMchId | string | 商户号 | - |
└─thirdpartyTradeType | string | 交易类型 | - |
└─thirdpartyTransactionId | string | 第三方交易流水号 | - |
└─thirdpartyUserOpenid | string | 第三方交易用户openid | - |
└─remark | string | 备注 | - |
Response-example:
{
"code": 41,
"message": "success",
"data": {
"id": 955,
"trxNo": "gft19a",
"payAmount": 3,
"prodTitle": "ad6m4d",
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"payType": "38czb1",
"created": "2023-08-14 12:03:45",
"payStatus": 924,
"payBankType": "1fouob",
"paySuccessAmount": 883,
"paySuccessTime": "2023-08-14 12:03:45",
"thirdpartyType": "z4tqt1",
"thirdpartyAppid": "144",
"thirdpartyMchId": "144",
"thirdpartyTradeType": "hq1snr",
"thirdpartyTransactionId": "144",
"thirdpartyUserOpenid": "144",
"remark": "3kd040"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/order/payment/detail/927
2.4. 资源管理
2.4.1. 资源列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 资源列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─resourceName | string | 资源名称 | - |
└─resourcePath | string | 资源路径 | - |
└─actionType | string | 读写类型 | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 205,
"message": "success",
"data": [
{
"lang": "380rhj",
"id": 46,
"resourceName": "kyong.mayert",
"resourcePath": "0uqzfr",
"actionType": "btif6u",
"language": "bq7ry1",
"created": "2023-08-14 12:03:45",
"updated": "2023-08-14 12:03:45"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/resource/list
2.4.2.
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: null
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 204,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/resource/sync
2.5. 角色管理
2.5.1. 角色列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 角色列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
roleName | string | false | 角色名称 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | ID | - |
└─roleName | string | 角色名称 | - |
└─roleDesc | string | 角色描述 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─active | int32 | 是否启用 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 107,
"message": "success",
"data": {
"total": 496,
"pages": 874,
"records": [
{
"id": 475,
"roleName": "kyong.mayert",
"roleDesc": "4qq2g2",
"created": "2023-08-14 12:03:45",
"updated": "2023-08-14 12:03:45",
"active": 653
}
],
"current": 119,
"size": 181,
"orders": [
{
"column": "z9z761",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 561
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/list?pageSize=903&roleName=kyong.mayert&pageNum=464
2.5.2. 保存角色
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存角色
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | ID | ||
roleName | string | true | 角色名称 | ||
roleDesc | string | false | 角色描述 | ||
created | string | false | 创建时间 | ||
updated | string | false | 修改时间 | ||
active | int32 | false | 是否启用 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 456,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/save --data 'active=137&id=983&roleName=kyong.mayert&updated=2023-08-14 12:03:45&roleDesc=vxfymr&created=2023-08-14 12:03:45'
2.5.3. 删除角色
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除角色
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
roleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 197,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/delete/392
2.5.4. 角色列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 角色列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | ID | - |
└─roleName | string | 角色名称 | - |
└─roleDesc | string | 角色描述 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─active | int32 | 是否启用 | - |
Response-example:
{
"code": 558,
"message": "success",
"data": [
{
"id": 324,
"roleName": "kyong.mayert",
"roleDesc": "tsy2ka",
"created": "2023-08-14 12:03:45",
"updated": "2023-08-14 12:03:45",
"active": 587
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/list/select
2.5.5. 角色权限列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 角色权限列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
roleId | int64 | true | 角色id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─permissions | array | 菜单权限 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─roleResources | array | 接口权限 | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─resourceName | string | 资源名称 | - |
└─resourcePath | string | 资源路径 | - |
└─actionType | string | 读写类型 | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
└─roleId | int64 | No comments found. | - |
Response-example:
{
"code": 543,
"message": "success",
"data": {
"permissions": [
{
"id": 710,
"parentId": 51,
"label": "d643hg",
"isShow": true,
"isChecked": true,
"sortNum": 69,
"children": [
{
"$ref": ".."
}
]
}
],
"roleResources": [
{
"lang": "sc38vx",
"id": 116,
"resourceName": "kyong.mayert",
"resourcePath": "x0iypp",
"actionType": "o4u0v2",
"language": "r7lkaq",
"created": "2023-08-14 12:03:45",
"updated": "2023-08-14 12:03:45",
"roleId": 693
}
]
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/382/permissions
2.5.6. 保存角色权限
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存角色权限
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
roleId | int64 | true | 角色id |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
permissionIdList | array | false | 权限id集合,[array of int64]@since | ||
resourcePathList | array | false | No comments found.,[array of string]@since |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 318,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/role/867/permissions/save --data 'permissionIdList=rlhxup&permissionIdList=rlhxup&resourcePathList=qd0u4w&resourcePathList=qd0u4w'
2.6. 用户管理
2.6.1. 用户列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
type | int32 | true | No comments found. | ||
username | string | false | No comments found. | ||
phone | string | false | 手机号码 | ||
deptId | int64 | false | No comments found. | ||
status | int32 | false | 状态 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | No comments found. | - |
└─userName | string | 登录账号 | - |
└─nickName | string | 用户昵称 | - |
└─realName | string | 真实姓名 | - |
string | 邮箱 | - | |
└─headImg | string | 头像 | - |
└─mobile | string | 手机号码 | - |
└─address | string | 通信地址 | - |
└─company | string | 所在公司 | - |
└─autograph | string | 个性签名 | - |
└─sex | int32 | 性别 | - |
└─source | string | 来源 | - |
└─salt | string | 加密盐值 | - |
└─status | int32 | 0禁用1正常 | - |
└─loginTime | string | 最近登录时间 | - |
└─accessIp | string | 登录ip | - |
└─userType | int32 | 用户类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─version | int32 | No comments found. | - |
└─errorCount | int32 | 密码输入错误次数 | - |
└─tagList | array | 标签名称集合 | - |
└─roleList | array | 已分配角色列表 | - |
└─deptList | array | 已分配的部门列表 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 248,
"message": "success",
"data": {
"total": 839,
"pages": 50,
"records": [
{
"id": 887,
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"realName": "kyong.mayert",
"email": "ryan.nicolas@yahoo.com",
"headImg": "i5fq6b",
"mobile": "(816) 208-8500",
"address": "Apt. 941 0251 Elmo Shores, North Kevenville, WI 78077",
"company": "Beahan, Ryan and Will",
"autograph": "o095fw",
"sex": 1,
"source": "uxdm0f",
"salt": "6m0y87",
"status": 981,
"loginTime": "2023-08-14 12:03:46",
"accessIp": "130.204.125.152",
"userType": 614,
"created": "2023-08-14 12:03:46",
"updated": "2023-08-14 12:03:46",
"version": 737,
"errorCount": 816,
"tagList": [
"3l9ctt"
],
"roleList": [
189
],
"deptList": [
191
]
}
],
"current": 18,
"size": 123,
"orders": [
{
"column": "dhdj7d",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 393
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/list?deptId=467&username=kyong.mayert&phone=1-813-715-9816&pageSize=242&status=721&type=160&pageNum=990
2.6.2. 新增用户
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 新增用户
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
userName | string | true | 登录账号 | ||
nickName | string | false | 用户昵称 | ||
realName | string | false | 真实姓名 | ||
string | false | 邮箱 | |||
headImg | string | false | 头像 | ||
mobile | string | false | 手机号码 | ||
address | string | false | 通信地址 | ||
company | string | false | 所在公司 | ||
autograph | string | false | 个性签名 | ||
sex | int32 | false | 性别 | ||
source | string | false | 来源 | ||
salt | string | false | 加密盐值 | ||
status | int32 | false | 0禁用1正常 | ||
loginTime | string | false | 最近登录时间 | ||
accessIp | string | false | 登录ip | ||
userType | int32 | false | 用户类型 | ||
created | string | false | 创建时间 | ||
updated | string | false | 修改时间 | ||
errorCount | int32 | false | 密码输入错误次数 | ||
tagList | array | false | 标签名称集合 | ||
roleList | array | false | 已分配角色列表 | ||
deptList | array | false | 已分配的部门列表 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 397,
"message": "success",
"data": 482
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/save --data 'status=896&mobile=(816) 208-8500&nickName=damian.botsford&userName=kyong.mayert&password=rucf11&salt=6j2u55&autograph=mz0gy8&sex=1&id=606&realName=kyong.mayert&loginTime=2023-08-14 12:03:46&created=2023-08-14 12:03:46&userType=173&accessIp=130.204.125.152&errorCount=146&updated=2023-08-14 12:03:46&headImg=5fhh89&address=Apt. 941 0251 Elmo Shores, North Kevenville, WI 78077&company=Beahan, Ryan and Will&email=ryan.nicolas@yahoo.com&source=m42n5n'
2.6.3. 用户信息
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户信息
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─userName | string | 登录账号 | - |
└─nickName | string | 用户昵称 | - |
└─realName | string | 真实姓名 | - |
string | 邮箱 | - | |
└─headImg | string | 头像 | - |
└─mobile | string | 手机号码 | - |
└─address | string | 通信地址 | - |
└─company | string | 所在公司 | - |
└─autograph | string | 个性签名 | - |
└─sex | int32 | 性别 | - |
└─source | string | 来源 | - |
└─salt | string | 加密盐值 | - |
└─status | int32 | 0禁用1正常 | - |
└─loginTime | string | 最近登录时间 | - |
└─accessIp | string | 登录ip | - |
└─userType | int32 | 用户类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─version | int32 | No comments found. | - |
└─errorCount | int32 | 密码输入错误次数 | - |
└─tagList | array | 标签名称集合 | - |
└─roleList | array | 已分配角色列表 | - |
└─deptList | array | 已分配的部门列表 | - |
Response-example:
{
"code": 514,
"message": "success",
"data": {
"id": 423,
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"realName": "kyong.mayert",
"email": "ryan.nicolas@yahoo.com",
"headImg": "u3px29",
"mobile": "(816) 208-8500",
"address": "Apt. 941 0251 Elmo Shores, North Kevenville, WI 78077",
"company": "Beahan, Ryan and Will",
"autograph": "70z89c",
"sex": 1,
"source": "zqxjgf",
"salt": "g1539i",
"status": 513,
"loginTime": "2023-08-14 12:03:46",
"accessIp": "130.204.125.152",
"userType": 363,
"created": "2023-08-14 12:03:46",
"updated": "2023-08-14 12:03:46",
"version": 360,
"errorCount": 460,
"tagList": [
"r42hxf"
],
"roleList": [
774
],
"deptList": [
272
]
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/746/get
2.6.4. 删除用户
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除用户
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 68,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/delete/563
2.6.5. 分配角色
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 分配角色
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | 用户id |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
roleIds | array | true | 角色集合,[array of int64]@since |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 348,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/189/roles/save --data 'roleIds=wnkmx4&roleIds=wnkmx4'
2.6.6. 分配标签
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 分配标签
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | 用户id |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
tagIds | array | true | 标签集合,[array of int64]@since |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 115,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/235/tags/save --data 'tagIds=0aomtg&tagIds=0aomtg'
2.6.7. 标签列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 标签列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─title | string | 标签名称 | - |
└─desc | string | 标签描述 | - |
└─sortNum | int32 | 排序 | - |
└─created | string | 创建时间 | - |
└─updated | string | 更新时间 | - |
Response-example:
{
"code": 306,
"message": "success",
"data": [
{
"id": 686,
"title": "85cp9y",
"desc": "nivt94",
"sortNum": 260,
"created": "2023-08-14 12:03:46",
"updated": "2023-08-14 12:03:46"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/tag/list
2.6.8. 修改密码
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 修改密码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | 用户id | ||
oldPassword | string | true | 旧密码 | ||
password | string | true | 新密码 | ||
confirmPassword | string | true | 旧密码 | ||
phoneCode | string | false | 手机验证码 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 485,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/password/update
2.6.9. 管理员重置用户密码
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 管理员重置用户密码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 581,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/reset/password --data 'userId=966'
2.6.10. 修改用户类型
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 修改用户类型
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | true | No comments found. | ||
userType | int32 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 330,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/user/changUserType --data 'userType=527&userId=669'
2.7. 登录授权
2.7.1. 登录
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 登录
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
ClientId | string | true | 自定义请求头 - ClientId |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
username | string | true | 账号 | ||
password | string | true | 密码 | ||
code | string | true | 验证码 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─token | string | token 令牌 | - |
└─tokenTtl | int64 | token 时效 | - |
└─superAdmin | boolean | 是否超级管理员 | - |
└─username | string | 账号 | - |
└─nickname | string | 昵称 | - |
└─headImg | string | 头像 | - |
└─hasRole | boolean | 是否拥有角色权限 | - |
└─version | string | 系统版本号 | - |
└─userType | int32 | 用户类型 | - |
Response-example:
{
"code": 541,
"message": "success",
"data": {
"token": "d5k7rr",
"tokenTtl": 940,
"superAdmin": true,
"username": "kyong.mayert",
"nickname": "damian.botsford",
"headImg": "xqbuox",
"hasRole": true,
"version": "0.34",
"userType": 176
}
}
Curl-example:
curl -X POST -H 'ClientId:clientId' -i http://127.0.0.1:8080/fastcms/api/admin/login --data 'username=admin&password=1&code=443'
2.7.2. 注册
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 注册
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
username | string | true | No comments found. | ||
nickName | string | true | No comments found. | ||
password | string | true | No comments found. | ||
repeatPassword | string | true | No comments found. | ||
code | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 833,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/register --data 'username=kyong.mayert&password=yh5xtz&nickName=damian.botsford&repeatPassword=bzms33&code=443'
2.7.3. 重置密码
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 重置密码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
username | string | true | No comments found. | ||
string | true | No comments found. | |||
code | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 770,
"message": "success",
"data": {
"waring": "You may have used non-display generics."
}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/reset/password --data 'username=kyong.mayert&code=443&email=ryan.nicolas@yahoo.com'
2.7.4. 验证码
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 验证码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─codeUuid | string | 验证码cache key | - |
└─image | string | 验证码图片 | - |
Response-example:
{
"code": 395,
"message": "success",
"data": {
"codeUuid": "bbe8601d-3e21-4e3f-b0ca-49e0e766f898",
"image": "rrjsx7"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/captcha
2.7.5. 首页数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 首页数据
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 752,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/index/data
2.8. 插件管理
2.8.1. 插件列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 插件列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
pluginId | string | false | 插件id | ||
provider | string | false | 插件作者 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 369,
"message": "success",
"data": {
"total": 713,
"pages": 413,
"records": [
{}
],
"current": 416,
"size": 976,
"orders": [
{
"column": "g3ho36",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 287
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/plugin/list?pageNum=689&pageSize=530&pluginId=144&provider=e8zlxw
2.8.2. 上传插件
Type: POST
Content-Type: multipart/form-data
Description: 上传插件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
file | file | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 944,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/plugin/install
2.8.3. 卸载插件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 卸载插件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pluginId | string | true | 插件id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 747,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/plugin/unInstall/144
2.8.4. 插件配置界面
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 插件配置界面
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pluginId | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 270,
"message": "success",
"data": "fd9x8b"
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/plugin/config/url/144
2.9. 配置
2.9.1. 保存配置
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存配置
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 204,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/config/save
2.9.2. 获取配置
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取配置
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
configKeys | array | true | No comments found.,[array of string]@since |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─key | string | 配置key键值 | - |
└─value | string | 配置值 | - |
Response-example:
{
"code": 649,
"message": "success",
"data": [
{
"id": 766,
"key": "soacdv",
"value": "fvzfud"
}
]
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/config/list --data 'configKeys=71lg65&configKeys=71lg65'
2.9.3. 获取配置(无需登录)
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取配置(无需登录)
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
configKeys | array | true | No comments found.,[array of string]@since |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─key | string | 配置key键值 | - |
└─value | string | 配置值 | - |
Response-example:
{
"code": 682,
"message": "success",
"data": [
{
"id": 976,
"key": "7u9aze",
"value": "myg6lb"
}
]
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/config/public/list --data 'configKeys=if9unb&configKeys=if9unb'
2.9.4. 测试邮件配置
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 测试邮件配置
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 527,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/config/mail/test
2.10. 部门管理
2.10.1. 部门列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 部门列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
status | int32 | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─deptName | string | No comments found. | - |
└─deptDesc | string | No comments found. | - |
└─status | int32 | No comments found. | - |
└─deptLeader | string | No comments found. | - |
└─deptPhone | string | No comments found. | - |
└─created | string | No comments found. | - |
Response-example:
{
"code": 267,
"message": "success",
"data": [
{
"id": 362,
"parentId": 643,
"label": "rqmae7",
"isShow": true,
"isChecked": true,
"sortNum": 152,
"children": [
{
"object": "any object"
}
],
"deptName": "kyong.mayert",
"deptDesc": "ozgjyk",
"status": 636,
"deptLeader": "yfu0a5",
"deptPhone": "1-813-715-9816",
"created": "2023-08-14 12:03:46"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/department/list?status=792
2.10.2. 保存部门
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存部门
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
parentId | int64 | false | 上级部门 | ||
deptName | string | false | 部门名称 | ||
deptDesc | string | false | 排序 | ||
deptPhone | string | false | 联系电话 | ||
deptAddr | string | false | 部门地址 | ||
status | int32 | false | 0,禁用,1启用 | ||
sortNum | int32 | false | 排序 | ||
deptLeader | string | false | 部门负责人 | ||
created | string | false | 创建时间 | ||
updated | string | false | 修改时间 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 531,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/department/save --data 'parentId=692&created=2023-08-14 12:03:46&status=849&deptDesc=wa4gua&deptName=kyong.mayert&deptAddr=x59x6g&sortNum=463&deptPhone=1-813-715-9816&updated=2023-08-14 12:03:46&id=136&deptLeader=fi530r'
2.10.3. 获取部门
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取部门
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
deptId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─parentId | int64 | 上级部门 | - |
└─deptName | string | 部门名称 | - |
└─deptDesc | string | 排序 | - |
└─deptPhone | string | 联系电话 | - |
└─deptAddr | string | 部门地址 | - |
└─status | int32 | 0,禁用,1启用 | - |
└─sortNum | int32 | 排序 | - |
└─deptLeader | string | 部门负责人 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
Response-example:
{
"code": 616,
"message": "success",
"data": {
"id": 428,
"parentId": 522,
"deptName": "kyong.mayert",
"deptDesc": "ayflls",
"deptPhone": "1-813-715-9816",
"deptAddr": "abpuf5",
"status": 737,
"sortNum": 935,
"deptLeader": "uy3sxf",
"created": "2023-08-14 12:03:46",
"updated": "2023-08-14 12:03:46"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/department/get/345
2.10.4. 删除部门
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除部门
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
deptId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 12,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/department/delete/36
2.11. 前端路由管理
2.11.1. 路由列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 路由列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─name | string | 名称 | - |
└─path | string | 路径 | - |
└─component | string | 组件 | - |
└─isLink | boolean | 是否链接 | - |
└─meta | object | 元数据 | - |
└─title | string | 标题 | - |
└─icon | string | 图标 | - |
└─isHide | boolean | 是否隐藏 | - |
└─isKeepAlive | boolean | 是否保持 | - |
└─isAffix | boolean | 是否固定 | - |
└─isIframe | boolean | 是否iframe | - |
Response-example:
{
"code": 26,
"message": "success",
"data": [
{
"id": 293,
"parentId": 559,
"label": "juylms",
"isShow": true,
"isChecked": true,
"sortNum": 225,
"children": [
{
"object": "any object"
}
],
"name": "kyong.mayert",
"path": "hep1h6",
"component": "0798ps",
"isLink": true,
"meta": {
"title": "fcadzz",
"icon": "veozfx",
"isHide": true,
"isKeepAlive": true,
"isAffix": true,
"isIframe": true
}
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/router/list
2.11.2. 保存路由
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存路由
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
parentId | int64 | false | 父节点id | ||
name | string | false | 名称 | ||
path | string | false | 路径 | ||
component | string | false | 组件 | ||
title | string | false | 标题 | ||
icon | string | false | 图标 | ||
isLink | boolean | false | 是否超链接 | ||
isHide | boolean | false | 是否隐藏 | ||
isKeepAlive | boolean | false | 是否保持 | ||
isAffix | boolean | false | 是否固定 | ||
isIframe | boolean | false | 是否iframe | ||
sortNum | int32 | false | 排序 | ||
category | string | false | 类别 | ||
created | string | false | 创建时间 | ||
updated | string | false | 更新时间 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 237,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/router/save --data 'sortNum=181&isKeepAlive=true&isAffix=true&icon=k5mz1g&title=kowvi0&isIframe=true&created=2023-08-14 12:03:47&category=4d61un&name=kyong.mayert&path=lu6n6o&updated=2023-08-14 12:03:47&isLink=true&parentId=391&component=imea22&id=339&isHide=true'
2.11.3. 获取路由
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取路由
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─parentId | int64 | 父节点id | - |
└─name | string | 名称 | - |
└─path | string | 路径 | - |
└─component | string | 组件 | - |
└─title | string | 标题 | - |
└─icon | string | 图标 | - |
└─isLink | boolean | 是否超链接 | - |
└─isHide | boolean | 是否隐藏 | - |
└─isKeepAlive | boolean | 是否保持 | - |
└─isAffix | boolean | 是否固定 | - |
└─isIframe | boolean | 是否iframe | - |
└─sortNum | int32 | 排序 | - |
└─category | string | 类别 | - |
└─created | string | 创建时间 | - |
└─updated | string | 更新时间 | - |
Response-example:
{
"code": 494,
"message": "success",
"data": {
"id": 693,
"parentId": 678,
"name": "kyong.mayert",
"path": "bgw86q",
"component": "e7hye4",
"title": "gyv29x",
"icon": "4fdd4i",
"isLink": true,
"isHide": true,
"isKeepAlive": true,
"isAffix": true,
"isIframe": true,
"sortNum": 530,
"category": "g63y6h",
"created": "2023-08-14 12:03:47",
"updated": "2023-08-14 12:03:47"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/router/get?id=144
2.11.4. 删除路由
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除路由
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
routerId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 414,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/router/delete/815
3. 基础-api
3.1. 文件上传
3.1.1. 上传
Type: POST
Content-Type: multipart/form-data
Description: 上传
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
files | file | true | No comments found.(array of file) |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 357,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/upload/
3.2. 部门
3.2.1. 部门列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 部门列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─deptName | string | No comments found. | - |
└─deptDesc | string | No comments found. | - |
└─status | int32 | No comments found. | - |
└─deptLeader | string | No comments found. | - |
└─deptPhone | string | No comments found. | - |
└─created | string | No comments found. | - |
Response-example:
{
"code": 528,
"message": "success",
"data": [
{
"id": 699,
"parentId": 567,
"label": "y9bq2v",
"isShow": true,
"isChecked": true,
"sortNum": 793,
"children": [
{
"object": "any object"
}
],
"deptName": "kyong.mayert",
"deptDesc": "xg3ie1",
"status": 297,
"deptLeader": "xuzuu7",
"deptPhone": "1-813-715-9816",
"created": "2023-08-14 12:03:47"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/department/list
3.3. 用户余额
3.3.1. 用户提现
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户提现
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
amount | number | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 396,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/amount/cashout --data 'amount=550'
3.3.2. 用户提现列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户提现列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 58,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/amount/cashout/list
3.3.3. 用户收入列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户收入列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 999,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/amount/income/list?pageNum=633&pageSize=829
3.3.4. 用户账户资金
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户账户资金
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 422,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/amount/get
3.4. 附件
3.4.1. 附件列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 附件列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
fileType | string | false | No comments found. | ||
fileName | string | false | 文件名称模糊搜索 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | 上传人id | - |
└─fileName | string | 原始文件名 | - |
└─fileDesc | string | 文件描述 | - |
└─filePath | string | 文件相对路径 | - |
└─fileType | string | 文件类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─fileSize | string | 文件大小 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 663,
"message": "success",
"data": {
"total": 441,
"pages": 559,
"records": [
{
"id": 862,
"createUserId": 798,
"fileName": "kyong.mayert",
"fileDesc": "5ir1ne",
"filePath": "7hk5s2",
"fileType": "yytdey",
"created": "2023-08-14 12:03:47",
"updated": "2023-08-14 12:03:47",
"fileSize": "2s8ryw"
}
],
"current": 688,
"size": 904,
"orders": [
{
"column": "qp31hl",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 946
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/attachment/list?fileType=fuuspb&pageNum=85&pageSize=283&fileName=kyong.mayert
3.4.2. 上传附件
Type: POST
Content-Type: multipart/form-data
Description: 上传附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
files | file | true | 待上传文件(array of file) |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 393,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/attachment/upload
3.4.3. 修改附件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 修改附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
fileName | string | true | 附件名称 | ||
fileDesc | string | false | 附件描述 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 366,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/attachment/update/806 --data 'fileName=kyong.mayert&fileDesc=w33tbc'
3.4.4. 附件明细
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 附件明细
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | 上传人id | - |
└─fileName | string | 原始文件名 | - |
└─fileDesc | string | 文件描述 | - |
└─filePath | string | 文件相对路径 | - |
└─fileType | string | 文件类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─fileSize | string | 文件大小 | - |
Response-example:
{
"code": 407,
"message": "success",
"data": {
"id": 795,
"createUserId": 483,
"fileName": "kyong.mayert",
"fileDesc": "3zjlhz",
"filePath": "0pshzo",
"fileType": "g5jo0m",
"created": "2023-08-14 12:03:47",
"updated": "2023-08-14 12:03:47",
"fileSize": "tp48vo"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/attachment/get/836
3.4.5. 删除附件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除附件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
attachId | int64 | true | 附件id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 608,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/attachment/delete/618
3.5. 用户
3.5.1. 保存用户
Type: POST
Content-Type: application/json; charset=utf-8
Description: 保存用户
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
nickName | string | false | 昵称 |
headImg | string | false | 头像 |
realName | string | false | 用户姓名 |
string | false | 邮箱 | |
mobile | string | false | 手机号 |
sex | int32 | false | 性别 |
autograph | string | false | 个性签名 |
Request-body:
{
"nickName": "damian.botsford",
"headImg": "57gn0w",
"realName": "kyong.mayert",
"email": "ryan.nicolas@yahoo.com",
"mobile": "(816) 208-8500",
"sex": 1,
"autograph": "b5th0s"
}
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 49,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/save --data '{
"nickName": "damian.botsford",
"headImg": "57gn0w",
"realName": "kyong.mayert",
"email": "ryan.nicolas@yahoo.com",
"mobile": "(816) 208-8500",
"sex": 1,
"autograph": "b5th0s"
}'
3.5.2. 用户详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
userId | int64 | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─userName | string | 登录账号 | - |
└─nickName | string | 用户昵称 | - |
└─realName | string | 真实姓名 | - |
string | 邮箱 | - | |
└─headImg | string | 头像 | - |
└─mobile | string | 手机号码 | - |
└─address | string | 通信地址 | - |
└─company | string | 所在公司 | - |
└─autograph | string | 个性签名 | - |
└─sex | int32 | 性别 | - |
└─source | string | 来源 | - |
└─salt | string | 加密盐值 | - |
└─status | int32 | 0禁用1正常 | - |
└─loginTime | string | 最近登录时间 | - |
└─accessIp | string | 登录ip | - |
└─userType | int32 | 用户类型 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─version | int32 | No comments found. | - |
└─errorCount | int32 | 密码输入错误次数 | - |
└─tagList | array | 标签名称集合 | - |
└─roleList | array | 已分配角色列表 | - |
└─deptList | array | 已分配的部门列表 | - |
Response-example:
{
"code": 884,
"message": "success",
"data": {
"id": 86,
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"realName": "kyong.mayert",
"email": "ryan.nicolas@yahoo.com",
"headImg": "saaw5e",
"mobile": "(816) 208-8500",
"address": "Apt. 941 0251 Elmo Shores, North Kevenville, WI 78077",
"company": "Beahan, Ryan and Will",
"autograph": "fzs41x",
"sex": 1,
"source": "k02w11",
"salt": "11bmbd",
"status": 94,
"loginTime": "2023-08-14 12:03:47",
"accessIp": "130.204.125.152",
"userType": 210,
"created": "2023-08-14 12:03:47",
"updated": "2023-08-14 12:03:47",
"version": 854,
"errorCount": 635,
"tagList": [
"z8psuf"
],
"roleList": [
290
],
"deptList": [
404
]
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/get?userId=135
3.5.3. 修改密码
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 修改密码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | int64 | false | 用户id | ||
oldPassword | string | true | 旧密码 | ||
password | string | true | 新密码 | ||
confirmPassword | string | true | 旧密码 | ||
phoneCode | string | false | 手机验证码 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 187,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/password/update
3.5.4. 保存头像
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存头像
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
path | string | false | No comments found. | ||
x | int32 | false | No comments found. | ||
y | int32 | false | No comments found. | ||
w | int32 | false | No comments found. | ||
h | int32 | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 858,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/user/avatar/save --data 'path=xrr70y&h=249&w=679&y=938&x=417'
3.6. 接收微信消息
3.6.1. 公众号服务器校验
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 公众号服务器校验
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
appId | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
signature | string | false | No comments found. | ||
timestamp | string | false | No comments found. | ||
nonce | string | false | No comments found. | ||
echostr | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 723,
"message": "success",
"data": "k2prqw"
}
Curl-example:
curl -X GET -i http://127.0.0.1:8080/wechat/message/144/mp?signature=wtsam9&echostr=t5lxp0&nonce=7zr0am×tamp=2023-08-14 12:03:41
3.6.2. 公众号消息接收
Type: POST
Content-Type: application/json; charset=utf-8
Description: 公众号消息接收
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
appId | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
signature | string | true | No comments found. | ||
timestamp | string | true | No comments found. | ||
nonce | string | true | No comments found. | ||
encrypt_type | string | false | No comments found. | ||
msg_signature | string | false | No comments found. |
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
requestBody | string | false | No comments found. |
Request-body:
{
"requestBody": "vlquds"
}
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 750,
"message": "success",
"data": "5njuza"
}
Curl-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://127.0.0.1:8080/wechat/message/144/mp?msg_signature=y2is55×tamp=2023-08-14 12:03:41&encrypt_type=j90xtt&signature=2f7wpz&nonce=y125br --data '{
"requestBody": "vlquds"
}'
3.7. 支付
3.7.1. 扫码支付 | 返回图片流
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 扫码支付 | 返回图片流
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | 支付平台 | ||
type | string | true | 支付方式 |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
- | int8 | Return int8. | - |
Response-example:
{
"code": 46,
"message": "success",
"data": [
"125",
"23"
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/qj4flh/lj15y6/toQrPay.jpg?orderId=6
3.7.2. 扫码支付 | 返回图片url
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 扫码支付 | 返回图片url
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | No comments found. | ||
type | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 512,
"message": "success",
"data": "96b487"
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/rsidxy/07ckih/getQrPay?orderId=435
3.7.3. 公众号支付
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 公众号支付
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | No comments found. | ||
type | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. | ||
openid | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 842,
"message": "success",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/ua3e4t/subebj/jsapi?orderId=767&openid=144
3.7.4. app支付 | 获取支付预订单信息
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: app支付 | 获取支付预订单信息
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | No comments found. | ||
type | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 113,
"message": "success",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/jvzadu/7imqk1/app?orderId=15
3.7.5. 刷卡付 | pos主动扫码付款(条码付)
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 刷卡付 | pos主动扫码付款(条码付)
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | 支付平台 | ||
type | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | 文章id | ||
authCode | string | true | 授权码,条码等 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 542,
"message": "success",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/tcqb36/yyfy0r/microPay?authCode=443&orderId=713
3.7.6. 刷脸付
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 刷脸付
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
platform | string | true | 支付平台 | ||
type | string | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. | ||
authCode | string | true | 人脸凭证 | ||
openid | string | false | 用户在商户 appid下的唯一标识 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 807,
"message": "success",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/pay/x9g2r0/ea4c8v/facePay?orderId=587&authCode=443&openid=144
3.8. 微信小程序登录授权
3.8.1. code2Session
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: code2Session
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
code | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─sessionKey | string | No comments found. | - |
└─openid | string | No comments found. | - |
└─unionid | string | No comments found. | - |
Response-example:
{
"code": 610,
"message": "success",
"data": {
"sessionKey": "tdn3y1",
"openid": "144",
"unionid": "144"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/wechat/miniapp/user/code2session?code=443
3.8.2. 登录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 登录
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
any object | object | false | any object. |
Request-body:
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─token | string | token 令牌 | - |
└─tokenTtl | int64 | token 时效 | - |
└─superAdmin | boolean | 是否超级管理员 | - |
└─username | string | 账号 | - |
└─nickname | string | 昵称 | - |
└─headImg | string | 头像 | - |
└─hasRole | boolean | 是否拥有角色权限 | - |
└─version | string | 系统版本号 | - |
└─userType | int32 | 用户类型 | - |
Response-example:
{
"code": 77,
"message": "success",
"data": {
"token": "koh59f",
"tokenTtl": 530,
"superAdmin": true,
"username": "kyong.mayert",
"nickname": "damian.botsford",
"headImg": "n2s212",
"hasRole": true,
"version": "0.34",
"userType": 630
}
}
Curl-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/wechat/miniapp/user/login --data '{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}'
3.8.3. 获取用户手机号码
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取用户手机号码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
code | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 358,
"message": "success",
"data": "m53syw"
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/wechat/miniapp/user/phone?code=443
3.8.4. 手机号码授权登录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 手机号码授权登录
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
any object | object | false | any object. |
Request-body:
{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─token | string | token 令牌 | - |
└─tokenTtl | int64 | token 时效 | - |
└─superAdmin | boolean | 是否超级管理员 | - |
└─username | string | 账号 | - |
└─nickname | string | 昵称 | - |
└─headImg | string | 头像 | - |
└─hasRole | boolean | 是否拥有角色权限 | - |
└─version | string | 系统版本号 | - |
└─userType | int32 | 用户类型 | - |
Response-example:
{
"code": 481,
"message": "success",
"data": {
"token": "fp3eso",
"tokenTtl": 464,
"superAdmin": true,
"username": "kyong.mayert",
"nickname": "damian.botsford",
"headImg": "xbty5n",
"hasRole": true,
"version": "0.34",
"userType": 497
}
}
Curl-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/wechat/miniapp/user/login/phone --data '{
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}'
3.8.5. 获取小程序二维码
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取小程序二维码
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
scene | string | false | No comments found. | ||
path | string | false | No comments found. | ||
envVersion | string | true |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 593,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/wechat/miniapp/user/getWxaQrCode?envVersion= release&scene=6e477o&path=pages/index/index
3.9. 订单
3.9.1. 创建普通订单
Type: POST
Content-Type: application/json; charset=utf-8
Description: 创建普通订单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Body-parameters:
Parameter | Type | Required | Description |
---|---|---|---|
products | array | false | 订单产品 |
└─id | int64 | false | 产品id |
└─type | string | false | 产品类型 |
└─num | int64 | false | 产品数量 |
└─sku | string | false | 产品sku |
addressId | int64 | false | 收货地址 |
buyerMsg | string | false | 买家留言 |
orderTypeClass | string | false | 订单逻辑处理类 |
priceTypeClass | string | false | 价格逻辑处理类 |
jsonExt | string | false | json扩展参数 |
Request-body:
{
"products": [
{
"id": 491,
"type": "7qfrdy",
"num": 693,
"sku": "izlprv"
}
],
"addressId": 834,
"buyerMsg": "466yho",
"orderTypeClass": "ydcvd2",
"priceTypeClass": "f8rjvt",
"jsonExt": "s6hmho"
}
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 108,
"message": "success",
"data": 145
}
Curl-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/order/save --data '{
"products": [
{
"id": 491,
"type": "7qfrdy",
"num": 693,
"sku": "izlprv"
}
],
"addressId": 834,
"buyerMsg": "466yho",
"orderTypeClass": "ydcvd2",
"priceTypeClass": "f8rjvt",
"jsonExt": "s6hmho"
}'
3.9.2. 订单列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 订单列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
payStatus | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int32 | 订单id | - |
└─orderSn | string | 订单编号 | - |
└─title | string | 商品名称 | - |
└─status | int32 | 订单状态 | - |
└─statusStr | string | 订单状态 | - |
└─payStatus | int32 | 支付状态 | - |
└─payStatusStr | string | 支付状态显示值 | - |
└─userName | string | 买家账号 | - |
└─nickName | string | 买家昵称 | - |
└─productCount | int32 | 商品数量 | - |
└─totalAmount | number | 商品金额 | - |
└─payAmount | number | 支付金额 | - |
└─thumbnail | string | 商品缩略图 | - |
└─created | string | 创建时间 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 653,
"message": "success",
"data": {
"total": 289,
"pages": 923,
"records": [
{
"id": 750,
"orderSn": "vy4nda",
"title": "noj7f9",
"status": 267,
"statusStr": "qfg97g",
"payStatus": 468,
"payStatusStr": "pfpe9k",
"userName": "kyong.mayert",
"nickName": "damian.botsford",
"productCount": 771,
"totalAmount": 262,
"payAmount": 372,
"thumbnail": "8eqfz0",
"created": "2023-08-14"
}
],
"current": 620,
"size": 920,
"orders": [
{
"column": "dwv3jq",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 640
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/order/list?pageNum=917&pageSize=98&payStatus=0
3.9.3. 订单详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 订单详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | 订单id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─orderSn | string | 订单号 | - |
└─createUserId | int64 | 购买人 | - |
└─orderTitle | string | No comments found. | - |
└─buyerMsg | string | 用户留言 | - |
└─orderAmount | number | 订单商品金额之和 | - |
└─payStatus | int32 | 支付状态 | - |
└─deliveryId | int64 | 发货情况 | - |
└─deliveryStatus | int32 | 1待发货,2已发货 | - |
└─consigneeUsername | string | 收货人地址 | - |
└─consigneeMobile | string | 收货人手机号(电话) | - |
└─consigneeAddrDetail | string | 收件人的详细地址 | - |
└─invoiceId | int32 | 发票 | - |
└─invoiceStatus | int32 | 发票开具状态:1 未申请发票、 2 发票申请中、 3 发票开具中、 4 无需开具发票、 5发票已经开具 | - |
└─postageAmount | number | 订单邮费 | - |
└─payAmount | number | 支付金额,商品金额 + 邮费 - 优惠或减免金额 | - |
└─remarks | string | 管理员后台备注 | - |
└─tradeStatus | int32 | 交易状态:1交易中、 2交易完成(但是可以申请退款) 、3取消交易 、4申请退款、 5拒绝退款、 6退款中、 7退款完成、 8交易结束 | - |
└─version | int32 | No comments found. | - |
└─jsonExt | string | json格式扩展字段 | - |
└─status | int32 | 删除状态:1 正常 ,0 已经删除 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─orderItemList | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─orderId | int64 | 订单id | - |
└─orderSn | string | 订单号 | - |
└─sellerId | int64 | 卖家id | - |
└─productId | int64 | 产品id | - |
└─productType | string | 产品类型 | - |
└─productCount | int32 | 产品数量 | - |
└─postageCost | number | 邮费 | - |
└─totalAmount | number | 具体金额 = 产品价格+运费+其他价格 | - |
└─updated | string | 修改时间 | - |
└─created | string | 创建时间 | - |
└─productTitle | string | 商品名称 | - |
└─productThumbnail | string | 商品缩略图 | - |
└─nickName | string | 买家昵称 | - |
└─userName | string | 买家账号 | - |
Response-example:
{
"code": 873,
"message": "success",
"data": {
"id": 533,
"orderSn": "abooge",
"createUserId": 494,
"orderTitle": "k60zsa",
"buyerMsg": "8dnjhk",
"orderAmount": 956,
"payStatus": 166,
"deliveryId": 105,
"deliveryStatus": 40,
"consigneeUsername": "kyong.mayert",
"consigneeMobile": "(816) 208-8500",
"consigneeAddrDetail": "y9rv4v",
"invoiceId": 726,
"invoiceStatus": 853,
"postageAmount": 952,
"payAmount": 288,
"remarks": "5zkpk3",
"tradeStatus": 648,
"version": 34,
"jsonExt": "oruxzb",
"status": 336,
"created": "2023-08-14 12:03:48",
"updated": "2023-08-14 12:03:48",
"orderItemList": [
{
"id": 384,
"orderId": 70,
"orderSn": "hfwkdt",
"sellerId": 180,
"productId": 430,
"productType": "5msqrv",
"productCount": 579,
"postageCost": 575,
"totalAmount": 775,
"updated": "2023-08-14 12:03:48",
"created": "2023-08-14 12:03:48",
"productTitle": "700bj4",
"productThumbnail": "srv8he"
}
],
"nickName": "damian.botsford",
"userName": "kyong.mayert"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/order/detail/929
3.9.4. 检查订单支付状态
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 检查订单支付状态
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
orderId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 643,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/order/status/check/319
4. CMS-admin
4.1. 页面管理
4.1.1. 页面列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 页面列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
title | string | false | No comments found. | ||
status | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | 主键ID | - |
└─createUserId | int64 | 创建者 | - |
└─title | string | 标题 | - |
└─path | string | 路径 | - |
└─contentHtml | string | 内容 | - |
└─outLink | string | 链接 | - |
└─seoKeywords | string | SEO关键字 | - |
└─seoDescription | string | SEO描述信息 | - |
└─summary | string | 摘要 | - |
└─thumbnail | string | 缩略图 | - |
└─style | string | 样式 | - |
└─status | string | 状态 | - |
└─suffix | string | 页面后缀 | - |
└─viewCount | int32 | 访问量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─language | string | 语言 | - |
└─created | string | 创建日期 | - |
└─updated | string | 最后更新日期 | - |
└─author | string | 创建者 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 16,
"message": "success",
"data": {
"total": 990,
"pages": 894,
"records": [
{
"url": "www.dana-little.us",
"lang": "7l8at1",
"id": 508,
"createUserId": 848,
"title": "6hd9ls",
"path": "ayhpwg",
"contentHtml": "xlpvyj",
"outLink": "tt9qp5",
"seoKeywords": "fzsqn6",
"seoDescription": "lus95b",
"summary": "tfdg50",
"thumbnail": "kyfath",
"style": "b9fef5",
"status": "8ip4cw",
"suffix": "6r7cdx",
"viewCount": 17,
"commentEnable": true,
"language": "8ubplq",
"created": "2023-08-14 12:03:41",
"updated": "2023-08-14 12:03:41",
"author": "Bonny Lesch"
}
],
"current": 690,
"size": 663,
"orders": [
{
"column": "rfdl8g",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 872
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/list?pageNum=316&pageSize=414&title=cjopni&status=7u4qcy
4.1.2. 保存页面
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存页面
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | 主键ID | ||
createUserId | int64 | false | 创建者 | ||
title | string | true | 标题 | ||
path | string | true | 路径 | ||
contentHtml | string | true | 内容 | ||
outLink | string | false | 链接 | ||
seoKeywords | string | true | SEO关键字 | ||
seoDescription | string | true | SEO描述信息 | ||
summary | string | false | 摘要 | ||
thumbnail | string | false | 缩略图 | ||
style | string | false | 样式 | ||
status | string | false | 状态 | ||
suffix | string | false | 页面后缀 | ||
viewCount | int32 | false | 访问量 | ||
commentEnable | boolean | false | 是否开启评论 | ||
language | string | false | 语言 | ||
created | string | false | 创建日期 | ||
updated | string | false | 最后更新日期 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 64,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/save --data 'tagStaticPath=quomhh&id=575&template.templatePath.parent.absolute=true&template.templatePath.root.nameCount=106&template.templatePath.parent.fileName.nameCount=79&template.templatePath.root.fileName.nameCount=719&thumbnail=3s4moc&viewCount=438&template.active=true&template.templatePath.fileName.absolute=true&template.templatePath.root.fileName.absolute=true&staticSuffix=6iqwdv&template.version=0.34&language=4meh3d&createUserId=801&template.templatePath.fileName.nameCount=270&template.templatePath.root.root.nameCount=492&enableStatic=true&template.path=hyvxbn&template.templatePath.fileName.root.absolute=true&template.templatePath.parent.nameCount=257&seoKeywords=v1yeyk&template.id=144&template.pathName=kyong.mayert&created=2023-08-14 12:03:42&template.description=2k9dsr&template.templatePath.fileName.root.nameCount=951&template.templatePath.fileName.parent.absolute=true&commentEnable=true&enable=true&seoDescription=h3ispg&url=www.dana-little.us&updated=2023-08-14 12:03:42&template.templatePath.root.root.absolute=true&template.templatePath.root.parent.absolute=true&template.templatePath.nameCount=537&categoryStaticPath=pw7ugi&template.templatePath.root.parent.nameCount=801&template.i18n=8gjo76&pageStaticPath=t0uwmw&template.templatePath.root.absolute=true&template.templatePath.absolute=true&template.templatePath.fileName.fileName.absolute=true&articleStaticPath=2pnxsw&status=h80tml&title=lb4ec5&template.templatePath.fileName.fileName.nameCount=837&summary=wnrgd1&suffix=b0fz4j&webSiteDomain=hane.org&outLink=39xxcq&template.templatePath.parent.fileName.absolute=true&enableFakeStatic=true&lang=kd7kbc&style=0k2kp1&template.provider=16in3j&template.templatePath.fileName.parent.nameCount=333&path=xi7jq0&contentHtml=sf9yxi&template.name=kyong.mayert'
4.1.3. 单页详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 单页详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | 主键ID | - |
└─createUserId | int64 | 创建者 | - |
└─title | string | 标题 | - |
└─path | string | 路径 | - |
└─contentHtml | string | 内容 | - |
└─outLink | string | 链接 | - |
└─seoKeywords | string | SEO关键字 | - |
└─seoDescription | string | SEO描述信息 | - |
└─summary | string | 摘要 | - |
└─thumbnail | string | 缩略图 | - |
└─style | string | 样式 | - |
└─status | string | 状态 | - |
└─suffix | string | 页面后缀 | - |
└─viewCount | int32 | 访问量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─language | string | 语言 | - |
└─created | string | 创建日期 | - |
└─updated | string | 最后更新日期 | - |
Response-example:
{
"code": 309,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "vsbffm",
"id": 353,
"createUserId": 637,
"title": "2c41xv",
"path": "5hao0a",
"contentHtml": "w1jzea",
"outLink": "y7p59y",
"seoKeywords": "d37slf",
"seoDescription": "1nr2sw",
"summary": "cix31z",
"thumbnail": "0ayk1l",
"style": "tijvv9",
"status": "u4vj3j",
"suffix": "stcbsm",
"viewCount": 496,
"commentEnable": true,
"language": "b7mkau",
"created": "2023-08-14 12:03:42",
"updated": "2023-08-14 12:03:42"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/get/144
4.1.4. 删除单页
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除单页
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
id | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 913,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/delete/144
4.1.5. 评论列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 评论列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
author | string | false | No comments found. | ||
content | string | false | No comments found. | ||
isParent | boolean | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 805,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/comment/list?author=Bonny Lesch&content=h89f6w&pageNum=0&pageSize=58&isParent=true
4.1.6. 保存评论
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存评论
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
lang | string | false | No comments found. | ||
id | int64 | false | 主键ID | ||
parentId | int64 | false | 回复的评论ID | ||
pageId | int64 | false | 评论的内容ID | ||
createUserId | int64 | false | 评论的用户ID | ||
content | string | true | 评论的内容 | ||
replyCount | int32 | false | 评论的回复数量 | ||
sortNum | int32 | false | 排序编号,常用语置顶等 | ||
status | string | false | 评论的状态 | ||
language | string | false | 语言 | ||
created | string | false | 评论的时间 | ||
updated | string | false | 修改时间 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 570,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/comment/save --data 'created=2023-08-14 12:03:42&replyCount=616&id=958&updated=2023-08-14 12:03:42&content=h830i4&language=p4gp8l&createUserId=515&sortNum=967&lang=e7v7yj&parentId=221&status=tim33l&pageId=889'
4.1.7. 删除评论
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除评论
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
commentId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 589,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/page/comment/delete/129
4.2. 模板管理
4.2.1. 模板列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 模板列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | string | 模板id | - |
└─name | string | 模板名称 | - |
└─path | string | 模板路径 | - |
└─i18n | string | i18n properties存储目录 | - |
└─pathName | string | 模板路径名称 | - |
└─version | string | 模板版本 | - |
└─provider | string | 模板提供者 | - |
└─description | string | 模板描述 | - |
└─active | boolean | No comments found. | - |
Response-example:
{
"code": 912,
"message": "success",
"data": [
{
"id": "144",
"name": "kyong.mayert",
"path": "5ulx6g",
"i18n": "eu7stl",
"pathName": "kyong.mayert",
"version": "0.34",
"provider": "yk5naf",
"description": "pkboip",
"active": true
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/list
4.2.2. 获取当前模板
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取当前模板
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | string | 模板id | - |
└─name | string | 模板名称 | - |
└─path | string | 模板路径 | - |
└─i18n | string | i18n properties存储目录 | - |
└─pathName | string | 模板路径名称 | - |
└─version | string | 模板版本 | - |
└─provider | string | 模板提供者 | - |
└─description | string | 模板描述 | - |
└─active | boolean | No comments found. | - |
Response-example:
{
"code": 948,
"message": "success",
"data": {
"id": "144",
"name": "kyong.mayert",
"path": "p44pw1",
"i18n": "y2e1oq",
"pathName": "kyong.mayert",
"version": "0.34",
"provider": "yts4z7",
"description": "lraw0i",
"active": true
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/current
4.2.3. 安装模板
Type: POST
Content-Type: multipart/form-data
Description: 安装模板
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
file | file | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 108,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/install
4.2.4. 卸载模板
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 卸载模板
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
templateId | string | true | 模板id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 510,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/unInstall/144
4.2.5. 获取模板文件树
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取模板文件树
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 914,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/files/tree/list
4.2.6. 获取文件内容
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取文件内容
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
filePath | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 185,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/files/get?filePath=fh4kck
4.2.7. 激活模板
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 激活模板
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
templateId | string | true | 模板id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 663,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/enable/144
4.2.8. 保存模板
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存模板
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
filePath | string | true | 文件 | ||
fileContent | string | true | 文件内容 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 434,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/file/save --data 'fileContent=q8q3y2&filePath=okxy8b'
4.2.9. 上传模板文件
Type: POST
Content-Type: multipart/form-data
Description: 上传模板文件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
dirName | string | false | No comments found. | ||
files | file | true | No comments found.(array of file) |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 822,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/files/upload --data 'dirName=kyong.mayert'
4.2.10. 删除模板文件
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除模板文件
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
filePath | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 903,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/file/delete --data 'filePath=ksee10'
4.2.11. 菜单列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 菜单列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─createUserId | int64 | 创建者 | - |
└─menuName | string | 菜单名称 | - |
└─menuUrl | string | 菜单地址 | - |
└─menuIcon | string | 菜单图标 | - |
└─sortNum | int32 | 排序 | - |
└─target | string | 打开方式 | - |
└─urlType | int32 | 菜单跳转url类型 1,文章,2,页面,3,分类, 4,标签 | - |
└─status | string | 状态 | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
└─children | array | No comments found. | - |
Response-example:
{
"code": 825,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"lang": "lny8ck",
"id": 709,
"parentId": 536,
"createUserId": 544,
"menuName": "kyong.mayert",
"menuUrl": "www.dana-little.us",
"menuIcon": "mjfliy",
"sortNum": 983,
"target": "43gkm0",
"urlType": 599,
"status": "dz441z",
"language": "hc8vqj",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43",
"children": [
{
"$ref": ".."
}
]
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/menu/list
4.2.12. 菜单信息
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 菜单信息
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
menuId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─createUserId | int64 | 创建者 | - |
└─menuName | string | 菜单名称 | - |
└─menuUrl | string | 菜单地址 | - |
└─menuIcon | string | 菜单图标 | - |
└─sortNum | int32 | 排序 | - |
└─target | string | 打开方式 | - |
└─urlType | int32 | 菜单跳转url类型 1,文章,2,页面,3,分类, 4,标签 | - |
└─status | string | 状态 | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 723,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "gyzwwy",
"id": 566,
"parentId": 327,
"createUserId": 847,
"menuName": "kyong.mayert",
"menuUrl": "www.dana-little.us",
"menuIcon": "51stmg",
"sortNum": 938,
"target": "bcf2jj",
"urlType": 0,
"status": "j72q7u",
"language": "6r6xvz",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/menu/get/564
4.2.13. 保存菜单
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存菜单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | id | ||
parentId | int64 | false | 上级id | ||
createUserId | int64 | false | 创建者 | ||
menuName | string | true | 菜单名称 | ||
menuUrl | string | true | 菜单地址 | ||
menuIcon | string | false | 菜单图标 | ||
sortNum | int32 | false | 排序 | ||
target | string | false | 打开方式 | ||
urlType | int32 | false | 菜单跳转url类型 1,文章,2,页面,3,分类, 4,标签 | ||
status | string | false | 状态 | ||
language | string | false | 语言 | ||
created | string | false | No comments found. | ||
updated | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 771,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/menu/save --data 'template.templatePath.absolute=true&template.templatePath.fileName.root.nameCount=844&menuName=kyong.mayert&template.i18n=7of9jw&staticSuffix=ly4wfc&template.name=kyong.mayert&template.pathName=kyong.mayert&template.templatePath.parent.fileName.nameCount=106&template.templatePath.fileName.nameCount=559&enableFakeStatic=true&template.description=99lgix&template.provider=bktsu6&template.templatePath.fileName.parent.nameCount=586&template.path=wwu8mu&template.templatePath.fileName.root.absolute=true&urlType=528&template.templatePath.root.root.absolute=true&created=2023-08-14 12:03:43&template.templatePath.root.parent.absolute=true&template.active=true&template.templatePath.root.root.nameCount=279&webSiteDomain=hane.org&target=gfd91n&url=www.dana-little.us&template.templatePath.fileName.fileName.nameCount=670&menuIcon=2zmqqa&enable=true&template.templatePath.fileName.parent.absolute=true&updated=2023-08-14 12:03:43&template.id=144&template.templatePath.root.fileName.nameCount=587&articleStaticPath=cwjjjg&template.templatePath.root.parent.nameCount=993&sortNum=230&categoryStaticPath=andq6z&template.templatePath.root.fileName.absolute=true&template.templatePath.parent.nameCount=569&tagStaticPath=eu0ygt&createUserId=868&template.templatePath.root.absolute=true&pageStaticPath=j094ow&menuUrl=www.dana-little.us&lang=xaz779&enableStatic=true&id=119&template.version=0.34&template.templatePath.nameCount=80&status=yabdpk&parentId=533&template.templatePath.root.nameCount=981&template.templatePath.parent.fileName.absolute=true&template.templatePath.fileName.fileName.absolute=true&template.templatePath.fileName.absolute=true&language=dton41&template.templatePath.parent.absolute=true'
4.2.14. 删除菜单
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除菜单
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
menuId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 184,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/template/menu/delete/289
4.3. 文章管理
4.3.1. 文章列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
title | string | false | 文章标题 | ||
status | string | false | 状态 | ||
categoryId | string | false | 分类id | ||
tagId | string | false | 标签id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 318,
"message": "success",
"data": {
"total": 983,
"pages": 15,
"records": [
{
"url": "www.dana-little.us",
"id": 106,
"title": "kaamk3",
"viewCount": 208,
"status": "o3nsus",
"created": "2023-08-14 12:03:43",
"author": "Bonny Lesch",
"outLink": "n1z5h2",
"thumbnail": "4vdsmk",
"summary": "hffcsw",
"zanCount": 155,
"commentCount": 665,
"jsonExt": "fc7e8m",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "hoxizk",
"id": 988,
"createUserId": 719,
"parentId": 431,
"title": "9z56c4",
"type": "x3vmm0",
"sortNum": 597,
"icon": "fte93e",
"suffix": "8r7qj2",
"path": "6gs3fa",
"language": "22te6i",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "v9kkhx",
"id": 561,
"createUserId": 42,
"tagName": "kyong.mayert",
"type": "3b8qds",
"icon": "fzcbgb",
"suffix": "cc2nr9",
"sortNum": 225,
"language": "3d2rqe",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43"
}
]
}
],
"current": 706,
"size": 739,
"orders": [
{
"column": "7a2k48",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 462
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/list?pageSize=801&status=ws7eax&title=1dcvnp&categoryId=144&tagId=144&pageNum=689
4.3.2. 保存文章
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存文章
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | id | ||
createUserId | int64 | false | 创建用户 | ||
title | string | true | 文章标题 | ||
contentHtml | string | true | 文章详情 | ||
summary | string | true | 文章摘要 | ||
seoKeywords | string | false | seo关键字 | ||
seoDescription | string | false | seo描述 | ||
outLink | string | false | 文章外链 | ||
sortNum | int32 | false | 文章排序,值越大越靠前 | ||
viewCount | int32 | false | 浏览量 | ||
commentEnable | boolean | false | 是否开启评论 | ||
thumbnail | string | true | 文章缩略图 | ||
status | string | false | 状态 | ||
suffix | string | false | 前缀 | ||
attachId | int64 | false | 附件 | ||
language | string | false | 语言 | ||
attachTitle | string | false | 附件名称 | ||
created | string | false | 创建时间 | ||
updated | string | false | 更新时间 | ||
version | int32 | false | No comments found. | ||
jsonExt | string | false | json格式扩展字段 | ||
articleCategory | array | false | 分类id集合 | ||
articleTag | array | false | 标签名称集合 | ||
highlightTitle | string | false | 搜索高亮标题 | ||
highlightContent | string | false | 搜索高亮内容 | ||
priceClass | string | false | 价格服务 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 524,
"message": "success",
"data": 436
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/save --data 'seoDescription=b0zw45&attachId=113&template.templatePath.fileName.nameCount=268&highlightContent=9jk5me&suffix=61pxce&commentEnable=true&sortNum=925&template.templatePath.root.nameCount=10&template.templatePath.parent.nameCount=362&lang=vuedww&enableFakeStatic=true&template.templatePath.fileName.fileName.nameCount=594&enableStatic=true&tagStaticPath=u0e98f&template.version=0.34&template.templatePath.root.root.absolute=true&template.id=144&template.active=true&template.templatePath.root.root.nameCount=551&jsonExt=70mpxs&template.templatePath.parent.absolute=true&webSiteDomain=hane.org&template.templatePath.fileName.absolute=true&template.templatePath.root.absolute=true&priceClass=zdkv7t&created=2023-08-14 12:03:43&template.templatePath.root.parent.absolute=true&template.templatePath.fileName.root.nameCount=796&contentHtml=9h9lyb&categoryStaticPath=7nawb6&template.templatePath.root.fileName.nameCount=69&template.templatePath.fileName.fileName.absolute=true&outLink=sknl21&thumbnail=pkx79r&template.templatePath.fileName.parent.absolute=true&updated=2023-08-14 12:03:43&title=iyp720&template.i18n=l62kvx&template.templatePath.parent.fileName.nameCount=27&url=www.dana-little.us&highlightTitle=qbo7ac&template.description=ube6gu&articleStaticPath=qmraix&seoKeywords=1a3atd&attachTitle=b5663z&viewCount=286&enable=true&template.templatePath.root.parent.nameCount=794&id=398&template.templatePath.nameCount=864&createUserId=466&template.path=k7abd3&staticSuffix=l3zr8n&template.name=kyong.mayert&language=836i40&version=121&template.pathName=kyong.mayert&template.templatePath.parent.fileName.absolute=true&template.templatePath.fileName.parent.nameCount=202&template.templatePath.root.fileName.absolute=true&pageStaticPath=6fzqcg&template.provider=n7gl06&template.templatePath.fileName.root.absolute=true&status=n751k0&summary=5wpztp&template.templatePath.absolute=true'
4.3.3. 文章详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | 文章id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建用户 | - |
└─title | string | 文章标题 | - |
└─contentHtml | string | 文章详情 | - |
└─summary | string | 文章摘要 | - |
└─seoKeywords | string | seo关键字 | - |
└─seoDescription | string | seo描述 | - |
└─outLink | string | 文章外链 | - |
└─sortNum | int32 | 文章排序,值越大越靠前 | - |
└─viewCount | int32 | 浏览量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─thumbnail | string | 文章缩略图 | - |
└─status | string | 状态 | - |
└─suffix | string | 前缀 | - |
└─attachId | int64 | 附件 | - |
└─language | string | 语言 | - |
└─attachTitle | string | 附件名称 | - |
└─created | string | 创建时间 | - |
└─updated | string | 更新时间 | - |
└─version | int32 | No comments found. | - |
└─jsonExt | string | json格式扩展字段 | - |
└─articleCategory | array | 分类id集合 | - |
└─articleTag | array | 标签名称集合 | - |
└─highlightTitle | string | 搜索高亮标题 | - |
└─highlightContent | string | 搜索高亮内容 | - |
└─priceClass | string | 价格服务 | - |
Response-example:
{
"code": 640,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "7mngl3",
"id": 427,
"createUserId": 244,
"title": "6bx7zx",
"contentHtml": "hjhys8",
"summary": "z9jfid",
"seoKeywords": "s4o030",
"seoDescription": "e30x75",
"outLink": "5p6r85",
"sortNum": 253,
"viewCount": 276,
"commentEnable": true,
"thumbnail": "v971yx",
"status": "ru1uku",
"suffix": "q28pky",
"attachId": 442,
"language": "crb6zp",
"attachTitle": "1uzboa",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43",
"version": 254,
"jsonExt": "x5bpjw",
"articleCategory": [
976
],
"articleTag": [
"hlswa1"
],
"highlightTitle": "gil15i",
"highlightContent": "krh7oq",
"priceClass": "mfcgxk"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/get/587
4.3.4. 删除文章
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除文章
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 944,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/delete/944
4.3.5. 保存分类
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存分类
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | id | ||
createUserId | int64 | false | 创建人 | ||
parentId | int64 | false | 上级分类 | ||
title | string | false | 分类标题 | ||
type | string | false | 类型 | ||
sortNum | int32 | false | 排序 | ||
icon | string | false | 分类图标 | ||
suffix | string | false | 访问标识 | ||
path | string | false | 访问路径 | ||
language | string | false | 语言 | ||
created | string | false | 创建时间 | ||
updated | string | false | 修改时间 | ||
iconUrl | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 752,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/category/save --data 'template.pathName=kyong.mayert&template.templatePath.parent.absolute=true&tagStaticPath=fqy9j2&enableFakeStatic=true&template.templatePath.parent.fileName.nameCount=580&template.templatePath.root.root.absolute=true&title=uuy8ff&webSiteDomain=hane.org&template.templatePath.fileName.root.absolute=true&updated=2023-08-14 12:03:43&id=649&type=44f03j&suffix=nmrj0g&template.templatePath.root.parent.nameCount=127&template.templatePath.root.fileName.nameCount=992&createUserId=918&template.templatePath.root.parent.absolute=true&template.templatePath.root.root.nameCount=980&template.templatePath.root.nameCount=355&template.i18n=7ivd8c&url=www.dana-little.us&sortNum=822&language=bvsy67&icon=ymj7ci&articleStaticPath=bbbkes&template.templatePath.parent.nameCount=775&template.templatePath.root.absolute=true&template.templatePath.fileName.nameCount=115&lang=tx1i83&staticSuffix=eoxsau&template.path=6hhsor&template.templatePath.fileName.parent.nameCount=279&template.templatePath.fileName.fileName.absolute=true&template.templatePath.parent.fileName.absolute=true&template.templatePath.root.fileName.absolute=true&template.templatePath.fileName.absolute=true&template.version=0.34&template.templatePath.absolute=true&template.templatePath.fileName.root.nameCount=42&template.id=144&template.templatePath.fileName.fileName.nameCount=782&template.provider=ofhm65&template.active=true&created=2023-08-14 12:03:43&template.name=kyong.mayert&categoryStaticPath=wuwmi6&iconUrl=www.dana-little.us&path=nwpcci&enableStatic=true&pageStaticPath=nri8tg&enable=true&template.description=oohan8&template.templatePath.nameCount=690&parentId=740&template.templatePath.fileName.parent.absolute=true'
4.3.6. 分类列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 分类列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─title | string | 分类标题 | - |
└─suffix | string | 模板标识 | - |
└─path | string | 访问路径 | - |
└─icon | string | 分类图标 | - |
└─iconUrl | string | 图片路径 | - |
└─created | string | 创建时间 | - |
└─url | string | 分类url | - |
Response-example:
{
"code": 441,
"message": "success",
"data": [
{
"id": 327,
"parentId": 900,
"label": "z6lott",
"isShow": true,
"isChecked": true,
"sortNum": 415,
"children": [
{
"object": "any object"
}
],
"title": "8b4071",
"suffix": "1eboki",
"path": "hx3nri",
"icon": "bkim6v",
"iconUrl": "www.dana-little.us",
"created": "2023-08-14 12:03:43",
"url": "www.dana-little.us"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/category/list
4.3.7. 获取分类
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取分类
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
categoryId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
Response-example:
{
"code": 492,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "6sc6je",
"id": 645,
"createUserId": 698,
"parentId": 436,
"title": "ordvos",
"type": "dln5x8",
"sortNum": 993,
"icon": "fic877",
"suffix": "v2g9mg",
"path": "exknvc",
"language": "tubeja",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43",
"iconUrl": "www.dana-little.us"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/category/get/437
4.3.8. 删除分类
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除分类
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
categoryId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 802,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/category/delete/912
4.3.9. 保存标签
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存标签
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | No comments found. | ||
createUserId | int64 | false | No comments found. | ||
tagName | string | false | No comments found. | ||
type | string | false | No comments found. | ||
icon | string | false | 标签图标 | ||
suffix | string | false | 访问标识,模板名称,结合网站模板使用 | ||
sortNum | int32 | false | No comments found. | ||
language | string | false | 语言 | ||
created | string | false | No comments found. | ||
updated | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 215,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/tag/save --data 'template.templatePath.fileName.root.nameCount=438&enableFakeStatic=true&template.templatePath.absolute=true&template.i18n=fuhgg2&template.templatePath.root.absolute=true&enableStatic=true&template.templatePath.root.fileName.nameCount=983&template.version=0.34&template.description=wjoma7&template.templatePath.fileName.parent.nameCount=219&template.templatePath.fileName.absolute=true&lang=fyte23&template.name=kyong.mayert&type=rf44mg&icon=25ivx0&staticSuffix=x4akbv&template.provider=wzph28&pageStaticPath=rf1he0&template.templatePath.fileName.fileName.nameCount=143&template.pathName=kyong.mayert&articleStaticPath=jv3pv1&template.templatePath.parent.fileName.nameCount=623&sortNum=270&suffix=b0wc61&template.templatePath.fileName.root.absolute=true&template.templatePath.root.fileName.absolute=true&template.templatePath.root.root.absolute=true&template.path=ttvqqa&updated=2023-08-14 12:03:43&webSiteDomain=hane.org&template.templatePath.nameCount=176&template.templatePath.parent.fileName.absolute=true&url=www.dana-little.us&created=2023-08-14 12:03:43&template.templatePath.root.root.nameCount=548&template.templatePath.root.nameCount=136&template.templatePath.parent.nameCount=637&categoryStaticPath=0e5wb5&template.templatePath.root.parent.absolute=true&template.templatePath.root.parent.nameCount=963&language=i8qe7t&template.templatePath.fileName.fileName.absolute=true&template.templatePath.fileName.parent.absolute=true&tagName=kyong.mayert&tagStaticPath=2gpgv9&template.templatePath.fileName.nameCount=243&template.templatePath.parent.absolute=true&enable=true&id=794&template.active=true&createUserId=349&template.id=144'
4.3.10. 标签列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 标签列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 487,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"lang": "yxg3vx",
"id": 422,
"createUserId": 934,
"tagName": "kyong.mayert",
"type": "3rb2l6",
"icon": "s0fxxf",
"suffix": "uxy1qz",
"sortNum": 574,
"language": "ka0kbc",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/tag/list
4.3.11. 获取标签
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 获取标签
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
tagId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 601,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "1lm7xc",
"id": 465,
"createUserId": 27,
"tagName": "kyong.mayert",
"type": "b199zy",
"icon": "nnmwi2",
"suffix": "yzx4rz",
"sortNum": 757,
"language": "eq3ss4",
"created": "2023-08-14 12:03:43",
"updated": "2023-08-14 12:03:43"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/tag/get/221
4.3.12. 删除标签
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除标签
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
tagId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 85,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/tag/delete/884
4.3.13. 评论列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 评论列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
author | string | false | No comments found. | ||
content | string | false | No comments found. | ||
isParent | boolean | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 499,
"message": "success",
"data": {}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/comment/list?pageSize=626&author=Bonny Lesch&isParent=true&pageNum=709&content=ilsbmh
4.3.14. 保存评论
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存评论
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
lang | string | false | No comments found. | ||
id | int64 | false | id | ||
createUserId | int64 | false | 创建人 | ||
parentId | int64 | false | 上级评论 | ||
articleId | int64 | false | 评论文章 | ||
content | string | true | 评论内容 | ||
sortNum | int32 | false | 排序 | ||
replyCount | int32 | false | 回复次数 | ||
upCount | int32 | false | 点赞次数 | ||
downCount | int32 | false | 踩赞次数 | ||
status | string | false | 状态 | ||
language | string | false | 语言 | ||
created | string | false | 创建时间 | ||
updated | string | false | 修改时间 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 728,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/comment/save --data 'status=z4cjad&updated=2023-08-14 12:03:43&upCount=807&id=396&language=2n2c09&downCount=706&lang=17y3h4&sortNum=149&createUserId=890&created=2023-08-14 12:03:43&content=rnno48&articleId=70&parentId=794&replyCount=957'
4.3.15. 删除评论
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除评论
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
commentId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 151,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/admin/article/comment/delete/626
5. CMS-api
5.1. 文章评论
5.1.1. 用户评论列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户评论列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
author | string | false | No comments found. | ||
content | string | false | No comments found. | ||
isParent | boolean | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | ID | - |
└─articleTitle | string | 文章标题 | - |
└─author | string | 作者 | - |
└─authorAvatar | string | 作者头像 | - |
└─content | string | 评论内容 | - |
└─parentComment | string | 回复内容 | - |
└─status | string | 状态 | - |
└─created | string | 创建者 | - |
└─replyCommentList | array | 回复列表 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 674,
"message": "success",
"data": {
"total": 117,
"pages": 202,
"records": [
{
"id": 660,
"articleTitle": "vfnbpj",
"author": "Bonny Lesch",
"authorAvatar": "e3wjzt",
"content": "tl56z6",
"parentComment": "fn8asf",
"status": "czwhfg",
"created": "2023-08-14 12:03:43",
"replyCommentList": [
{
"$ref": ".."
}
]
}
],
"current": 259,
"size": 846,
"orders": [
{
"column": "bfqw87",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 415
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/comment/user/list?pageNum=776&content=vy7sb4&pageSize=527&isParent=true&author=Bonny Lesch
5.1.2. 文章评论列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章评论列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─id | int64 | ID | - |
└─articleTitle | string | 文章标题 | - |
└─author | string | 作者 | - |
└─authorAvatar | string | 作者头像 | - |
└─content | string | 评论内容 | - |
└─parentComment | string | 回复内容 | - |
└─status | string | 状态 | - |
└─created | string | 创建者 | - |
└─replyCommentList | array | 回复列表 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 829,
"message": "success",
"data": {
"total": 416,
"pages": 588,
"records": [
{
"id": 788,
"articleTitle": "0xfo81",
"author": "Bonny Lesch",
"authorAvatar": "rbufzt",
"content": "z7a33n",
"parentComment": "syftbx",
"status": "x4e758",
"created": "2023-08-14 12:03:43",
"replyCommentList": [
{
"$ref": ".."
}
]
}
],
"current": 397,
"size": 64,
"orders": [
{
"column": "pm4fxc",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 703
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/comment/list/727?pageSize=470&pageNum=384
5.1.3. 保存评论
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存评论
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. | ||
commentId | int64 | true | No comments found. | ||
context | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 819,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/comment/save --data 'commentId=898&articleId=689&context=rl59s1'
5.2. 文章点赞
5.2.1. 文章点赞列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章点赞列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 356,
"message": "success",
"data": {
"total": 576,
"pages": 51,
"records": [
{
"object": "any object"
}
],
"current": 561,
"size": 643,
"orders": [
{
"column": "o2q11j",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 594
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/zan/list?pageNum=60&pageSize=410&articleId=568
5.2.2. 用户点赞
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户点赞
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─articleId | int64 | No comments found. | - |
└─created | string | No comments found. | - |
Response-example:
{
"code": 363,
"message": "success",
"data": {
"id": 914,
"createUserId": 585,
"articleId": 865,
"created": "2023-08-14 12:03:44"
}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/zan/save --data 'articleId=866'
5.2.3. 用户取消点赞
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户取消点赞
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 340,
"message": "success",
"data": true
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/zan/cancel --data 'articleId=805'
5.2.4. 用户是否点过赞
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 用户是否点过赞
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 372,
"message": "success",
"data": true
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/zan/user/had/zan?articleId=62
5.3. 文章接口
5.3.1. 文章列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
categoryId | string | false | No comments found. | ||
tagId | string | false | No comments found. | ||
orderBy | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 559,
"message": "success",
"data": {
"total": 207,
"pages": 932,
"records": [
{
"url": "www.dana-little.us",
"id": 372,
"title": "kj9z58",
"viewCount": 627,
"status": "5scdgl",
"created": "2023-08-14 12:03:44",
"author": "Bonny Lesch",
"outLink": "c6icf2",
"thumbnail": "c9f7dz",
"summary": "07z9za",
"zanCount": 73,
"commentCount": 688,
"jsonExt": "92xmjv",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "xeyssf",
"id": 206,
"createUserId": 222,
"parentId": 244,
"title": "w5u27x",
"type": "xs3b83",
"sortNum": 193,
"icon": "vveuky",
"suffix": "muwynn",
"path": "ynhuby",
"language": "tkj83q",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "2jj26z",
"id": 591,
"createUserId": 598,
"tagName": "kyong.mayert",
"type": "iqbi5u",
"icon": "1ajg43",
"suffix": "13kfd2",
"sortNum": 911,
"language": "b8zpwj",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
],
"current": 267,
"size": 701,
"orders": [
{
"column": "v11sov",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 339
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/list?pageSize=332&pageNum=79&tagId=144&categoryId=144&orderBy=a.created
5.3.2. 文章列表(open)
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章列表(open)
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
categoryId | string | false | No comments found. | ||
tagId | string | false | No comments found. | ||
orderBy | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 256,
"message": "success",
"data": {
"total": 242,
"pages": 26,
"records": [
{
"url": "www.dana-little.us",
"id": 267,
"title": "ro5mbl",
"viewCount": 134,
"status": "ewtyw0",
"created": "2023-08-14 12:03:44",
"author": "Bonny Lesch",
"outLink": "b4807m",
"thumbnail": "5esv23",
"summary": "zuev6d",
"zanCount": 687,
"commentCount": 8,
"jsonExt": "mwjtla",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "raspai",
"id": 62,
"createUserId": 570,
"parentId": 586,
"title": "5ae8bx",
"type": "d7lv1u",
"sortNum": 568,
"icon": "v09aaf",
"suffix": "wmz652",
"path": "hd5v0n",
"language": "lsr9dw",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "d4vvvf",
"id": 167,
"createUserId": 437,
"tagName": "kyong.mayert",
"type": "uw01iu",
"icon": "ili247",
"suffix": "x6x0u6",
"sortNum": 345,
"language": "9g283o",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
],
"current": 59,
"size": 776,
"orders": [
{
"column": "87pzt1",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 369
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/list/open?pageNum=780&categoryId=144&pageSize=261&orderBy=a.created&tagId=144
5.3.3. 根据多个分类获取文章列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据多个分类获取文章列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
categoryIds | string | true | 多个分类以英文逗号隔开 | ||
count | int32 | false | No comments found. | ||
orderBy | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 108,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"id": 965,
"title": "xnyfzd",
"viewCount": 787,
"status": "1byk8y",
"created": "2023-08-14 12:03:44",
"author": "Bonny Lesch",
"outLink": "ergbh5",
"thumbnail": "fnfpza",
"summary": "t7bb7q",
"zanCount": 480,
"commentCount": 377,
"jsonExt": "pjfdpe",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "vfv1x5",
"id": 881,
"createUserId": 836,
"parentId": 714,
"title": "iwekh2",
"type": "or0juz",
"sortNum": 223,
"icon": "sog7bg",
"suffix": "wkhnj5",
"path": "kvdee8",
"language": "rcd89t",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "gbvg4g",
"id": 317,
"createUserId": 16,
"tagName": "kyong.mayert",
"type": "14ndgt",
"icon": "9rxigv",
"suffix": "im3ge2",
"sortNum": 826,
"language": "rop18w",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/list/category/ids?count=20&orderBy=a.created&categoryIds=cn0ruf
5.3.4. 根据多个标签获取文章列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据多个标签获取文章列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
tagIds | string | true | 多个标签以英文逗号隔开 | ||
count | int32 | false | No comments found. | ||
orderBy | string | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 624,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"id": 597,
"title": "rulsz6",
"viewCount": 323,
"status": "w45291",
"created": "2023-08-14 12:03:44",
"author": "Bonny Lesch",
"outLink": "r8xrp4",
"thumbnail": "ih680e",
"summary": "mm3l9x",
"zanCount": 844,
"commentCount": 847,
"jsonExt": "fr7rmv",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "2tjjat",
"id": 657,
"createUserId": 316,
"parentId": 36,
"title": "vh11k1",
"type": "z0c3sp",
"sortNum": 609,
"icon": "1btovw",
"suffix": "ky1hhx",
"path": "cve1j5",
"language": "hf2d85",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "0pzmla",
"id": 806,
"createUserId": 737,
"tagName": "kyong.mayert",
"type": "6351pt",
"icon": "m5aa2v",
"suffix": "5t4ffd",
"sortNum": 693,
"language": "9q1ezk",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/list/tag/ids?tagIds=hjl7fn&count=20&orderBy=a.created
5.3.5. 根据标签获取文章列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 根据标签获取文章列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
tagId | int64 | true | No comments found. | ||
includeTagIds | string | false | 多个以逗号隔开 | ||
excludeTagIds | string | false | 多个以逗号隔开 | ||
count | int32 | false | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─id | int64 | id | - |
└─title | string | 标题 | - |
└─viewCount | int32 | 浏览次数 | - |
└─status | string | 状态 | - |
└─created | string | 创建时间 | - |
└─author | string | 作者 | - |
└─outLink | string | 文章外部链接 | - |
└─thumbnail | string | 缩略图 | - |
└─summary | string | 文章摘要 | - |
└─zanCount | int32 | 点赞数 | - |
└─commentCount | int32 | 评论数 | - |
└─jsonExt | string | 扩展字段 | - |
└─categoryList | array | 文章所属分类 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建人 | - |
└─parentId | int64 | 上级分类 | - |
└─title | string | 分类标题 | - |
└─type | string | 类型 | - |
└─sortNum | int32 | 排序 | - |
└─icon | string | 分类图标 | - |
└─suffix | string | 访问标识 | - |
└─path | string | 访问路径 | - |
└─language | string | 语言 | - |
└─created | string | 创建时间 | - |
└─updated | string | 修改时间 | - |
└─iconUrl | string | No comments found. | - |
└─tagList | array | 文章所属标签 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 769,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"id": 914,
"title": "ntpjdp",
"viewCount": 109,
"status": "n9s0kn",
"created": "2023-08-14 12:03:44",
"author": "Bonny Lesch",
"outLink": "nkk9u9",
"thumbnail": "jzn0p6",
"summary": "zaaj9z",
"zanCount": 54,
"commentCount": 50,
"jsonExt": "6iuuy7",
"categoryList": [
{
"url": "www.dana-little.us",
"lang": "9h362r",
"id": 934,
"createUserId": 620,
"parentId": 106,
"title": "kmeoks",
"type": "v9mmj7",
"sortNum": 246,
"icon": "my6eis",
"suffix": "vby3ub",
"path": "7e4emn",
"language": "xmvy3e",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"iconUrl": "www.dana-little.us"
}
],
"tagList": [
{
"url": "www.dana-little.us",
"lang": "2odj7s",
"id": 564,
"createUserId": 317,
"tagName": "kyong.mayert",
"type": "6ryw6j",
"icon": "kn7qmf",
"suffix": "jt6e6p",
"sortNum": 452,
"language": "imlac6",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/list/tagId?count=700&excludeTagIds=wkatms&tagId=151&includeTagIds=v7u8x6
5.3.6. 保存文章
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 保存文章
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
url | string | false | 获取访问的url | ||
lang | string | false | No comments found. | ||
id | int64 | false | id | ||
createUserId | int64 | false | 创建用户 | ||
title | string | true | 文章标题 | ||
contentHtml | string | true | 文章详情 | ||
summary | string | true | 文章摘要 | ||
seoKeywords | string | false | seo关键字 | ||
seoDescription | string | false | seo描述 | ||
outLink | string | false | 文章外链 | ||
sortNum | int32 | false | 文章排序,值越大越靠前 | ||
viewCount | int32 | false | 浏览量 | ||
commentEnable | boolean | false | 是否开启评论 | ||
thumbnail | string | true | 文章缩略图 | ||
status | string | false | 状态 | ||
suffix | string | false | 前缀 | ||
attachId | int64 | false | 附件 | ||
language | string | false | 语言 | ||
attachTitle | string | false | 附件名称 | ||
created | string | false | 创建时间 | ||
updated | string | false | 更新时间 | ||
version | int32 | false | No comments found. | ||
jsonExt | string | false | json格式扩展字段 | ||
articleCategory | array | false | 分类id集合 | ||
articleTag | array | false | 标签名称集合 | ||
highlightTitle | string | false | 搜索高亮标题 | ||
highlightContent | string | false | 搜索高亮内容 | ||
priceClass | string | false | 价格服务 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 804,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/save --data 'template.templatePath.fileName.parent.nameCount=966&jsonExt=5mi8n6&template.templatePath.root.root.absolute=true&template.description=q6mjpu&template.templatePath.fileName.parent.absolute=true&url=www.dana-little.us&template.templatePath.root.nameCount=570&updated=2023-08-14 12:03:44&seoDescription=jcljgy&version=4&title=uv43qw&template.templatePath.root.fileName.nameCount=82&template.templatePath.parent.nameCount=91&contentHtml=o6x80d&template.templatePath.absolute=true&template.templatePath.fileName.root.nameCount=196&template.templatePath.root.root.nameCount=999&template.provider=yad65m&tagStaticPath=v4g977&enableStatic=true&template.templatePath.parent.absolute=true&highlightContent=u3tsnw&suffix=qqjl61&enableFakeStatic=true&summary=lh6zsb&attachTitle=9tmm8y&categoryStaticPath=516psm&enable=true&viewCount=15&template.templatePath.root.absolute=true&attachId=254&webSiteDomain=hane.org&template.templatePath.fileName.root.absolute=true&highlightTitle=hylurz&created=2023-08-14 12:03:44&template.templatePath.root.fileName.absolute=true&template.templatePath.fileName.absolute=true&articleStaticPath=xscv5d&template.version=0.34&template.templatePath.fileName.fileName.absolute=true&template.templatePath.root.parent.absolute=true&template.active=true&commentEnable=true&lang=828fbs&pageStaticPath=fzdhlw&template.templatePath.nameCount=232&priceClass=5ybynn&createUserId=235&template.templatePath.fileName.nameCount=679&sortNum=96&template.templatePath.fileName.fileName.nameCount=283&outLink=p4u8ih&template.id=144&status=tqm7ow&template.templatePath.parent.fileName.absolute=true&staticSuffix=zqausw&template.templatePath.parent.fileName.nameCount=595&template.name=kyong.mayert&template.pathName=kyong.mayert&id=681&language=mqfgab&template.templatePath.root.parent.nameCount=797&thumbnail=49lgmb&template.i18n=qe8ljb&template.path=8euoq3&seoKeywords=mcvjkf'
5.3.7. 文章详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | 文章id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建用户 | - |
└─title | string | 文章标题 | - |
└─contentHtml | string | 文章详情 | - |
└─summary | string | 文章摘要 | - |
└─seoKeywords | string | seo关键字 | - |
└─seoDescription | string | seo描述 | - |
└─outLink | string | 文章外链 | - |
└─sortNum | int32 | 文章排序,值越大越靠前 | - |
└─viewCount | int32 | 浏览量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─thumbnail | string | 文章缩略图 | - |
└─status | string | 状态 | - |
└─suffix | string | 前缀 | - |
└─attachId | int64 | 附件 | - |
└─language | string | 语言 | - |
└─attachTitle | string | 附件名称 | - |
└─created | string | 创建时间 | - |
└─updated | string | 更新时间 | - |
└─version | int32 | No comments found. | - |
└─jsonExt | string | json格式扩展字段 | - |
└─articleCategory | array | 分类id集合 | - |
└─articleTag | array | 标签名称集合 | - |
└─highlightTitle | string | 搜索高亮标题 | - |
└─highlightContent | string | 搜索高亮内容 | - |
└─priceClass | string | 价格服务 | - |
Response-example:
{
"code": 361,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "7z8gnb",
"id": 428,
"createUserId": 460,
"title": "uwddyf",
"contentHtml": "99l14d",
"summary": "z06gdt",
"seoKeywords": "eu9aph",
"seoDescription": "vk2dbp",
"outLink": "56sjl9",
"sortNum": 923,
"viewCount": 379,
"commentEnable": true,
"thumbnail": "w7301d",
"status": "cq11nb",
"suffix": "360wbn",
"attachId": 349,
"language": "daj10h",
"attachTitle": "t0oz75",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"version": 507,
"jsonExt": "ybroy5",
"articleCategory": [
163
],
"articleTag": [
"7k6c01"
],
"highlightTitle": "31a9bc",
"highlightContent": "a1mrov",
"priceClass": "2gy2bs"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/get/585
5.3.8. 删除文章
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 删除文章
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
articleId | int64 | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 391,
"message": "success",
"data": {}
}
Curl-example:
curl -X POST -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/delete/781
5.3.9. 文章搜索
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章搜索
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 | ||
keyword | string | true | No comments found. |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | id | - |
└─createUserId | int64 | 创建用户 | - |
└─title | string | 文章标题 | - |
└─contentHtml | string | 文章详情 | - |
└─summary | string | 文章摘要 | - |
└─seoKeywords | string | seo关键字 | - |
└─seoDescription | string | seo描述 | - |
└─outLink | string | 文章外链 | - |
└─sortNum | int32 | 文章排序,值越大越靠前 | - |
└─viewCount | int32 | 浏览量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─thumbnail | string | 文章缩略图 | - |
└─status | string | 状态 | - |
└─suffix | string | 前缀 | - |
└─attachId | int64 | 附件 | - |
└─language | string | 语言 | - |
└─attachTitle | string | 附件名称 | - |
└─created | string | 创建时间 | - |
└─updated | string | 更新时间 | - |
└─version | int32 | No comments found. | - |
└─jsonExt | string | json格式扩展字段 | - |
└─articleCategory | array | 分类id集合 | - |
└─articleTag | array | 标签名称集合 | - |
└─highlightTitle | string | 搜索高亮标题 | - |
└─highlightContent | string | 搜索高亮内容 | - |
└─priceClass | string | 价格服务 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 116,
"message": "success",
"data": {
"total": 339,
"pages": 477,
"records": [
{
"url": "www.dana-little.us",
"lang": "mhj2ej",
"id": 292,
"createUserId": 718,
"title": "ejzpif",
"contentHtml": "o50uwj",
"summary": "togg5l",
"seoKeywords": "hlmb6l",
"seoDescription": "i2ziry",
"outLink": "sbpq7g",
"sortNum": 568,
"viewCount": 373,
"commentEnable": true,
"thumbnail": "dey3f9",
"status": "91q8ij",
"suffix": "qlfwn6",
"attachId": 36,
"language": "cz0bdr",
"attachTitle": "a8bdu8",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44",
"version": 578,
"jsonExt": "z0xrq4",
"articleCategory": [
201
],
"articleTag": [
"orj1d2"
],
"highlightTitle": "y635zp",
"highlightContent": "3o8s4r",
"priceClass": "qobdfa"
}
],
"current": 209,
"size": 546,
"orders": [
{
"column": "k1n2vn",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 143
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/search?pageSize=695&pageNum=592&keyword=tqgk61
5.3.10. 文章分类
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章分类
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─id | int64 | id | - |
└─parentId | int64 | 上级id | - |
└─label | string | 名称 | - |
└─isShow | boolean | 是否显示 | - |
└─isChecked | boolean | 是否被选中 | - |
└─sortNum | int32 | 排序 | - |
└─children | array | 子节点集合 | - |
└─title | string | 分类标题 | - |
└─suffix | string | 模板标识 | - |
└─path | string | 访问路径 | - |
└─icon | string | 分类图标 | - |
└─iconUrl | string | 图片路径 | - |
└─created | string | 创建时间 | - |
└─url | string | 分类url | - |
Response-example:
{
"code": 604,
"message": "success",
"data": [
{
"id": 464,
"parentId": 340,
"label": "ma3nkt",
"isShow": true,
"isChecked": true,
"sortNum": 580,
"children": [
{
"object": "any object"
}
],
"title": "ra59y4",
"suffix": "b2ygni",
"path": "vdkp61",
"icon": "gqse10",
"iconUrl": "www.dana-little.us",
"created": "2023-08-14 12:03:44",
"url": "www.dana-little.us"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/category/list
5.3.11. 文章标签
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 文章标签
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | array | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | No comments found. | - |
└─createUserId | int64 | No comments found. | - |
└─tagName | string | No comments found. | - |
└─type | string | No comments found. | - |
└─icon | string | 标签图标 | - |
└─suffix | string | 访问标识,模板名称,结合网站模板使用 | - |
└─sortNum | int32 | No comments found. | - |
└─language | string | 语言 | - |
└─created | string | No comments found. | - |
└─updated | string | No comments found. | - |
Response-example:
{
"code": 611,
"message": "success",
"data": [
{
"url": "www.dana-little.us",
"lang": "k5scnk",
"id": 240,
"createUserId": 328,
"tagName": "kyong.mayert",
"type": "ykpkvp",
"icon": "aid59g",
"suffix": "fjwfuf",
"sortNum": 922,
"language": "d2z394",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
]
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/article/tag/list
5.4.
5.4.1. 页面列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 页面列表
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Query-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageNum | int64 | false | 页码 | ||
pageSize | int64 | false | 每页条数 |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数 | - |
└─pages | int64 | No comments found. | - |
└─records | array | 查询数据列表 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | 主键ID | - |
└─createUserId | int64 | 创建者 | - |
└─title | string | 标题 | - |
└─path | string | 路径 | - |
└─contentHtml | string | 内容 | - |
└─outLink | string | 链接 | - |
└─seoKeywords | string | SEO关键字 | - |
└─seoDescription | string | SEO描述信息 | - |
└─summary | string | 摘要 | - |
└─thumbnail | string | 缩略图 | - |
└─style | string | 样式 | - |
└─status | string | 状态 | - |
└─suffix | string | 页面后缀 | - |
└─viewCount | int32 | 访问量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─language | string | 语言 | - |
└─created | string | 创建日期 | - |
└─updated | string | 最后更新日期 | - |
└─current | int64 | 当前页 | - |
└─size | int64 | 每页显示条数,默认 10 | - |
└─orders | array | 排序字段信息 | - |
└─column | string | No comments found. | - |
└─asc | boolean | No comments found. | - |
└─optimizeCountSql | boolean | 自动优化 COUNT SQL | - |
└─searchCount | boolean | 是否进行 count 查询 | - |
└─optimizeJoinOfCountSql | boolean | {@link #optimizeJoinOfCountSql()} | - |
└─countId | string | countId | - |
└─maxLimit | int64 | countId | - |
Response-example:
{
"code": 163,
"message": "success",
"data": {
"total": 400,
"pages": 135,
"records": [
{
"url": "www.dana-little.us",
"lang": "iq1h80",
"id": 65,
"createUserId": 388,
"title": "e43auv",
"path": "xtf8qc",
"contentHtml": "01vd0l",
"outLink": "6aij6g",
"seoKeywords": "fwh0az",
"seoDescription": "1s8ypz",
"summary": "6pnm9n",
"thumbnail": "7wl9tr",
"style": "unglny",
"status": "vuschy",
"suffix": "vj6rv1",
"viewCount": 994,
"commentEnable": true,
"language": "xrawuu",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
],
"current": 310,
"size": 861,
"orders": [
{
"column": "bnj9kf",
"asc": true
}
],
"optimizeCountSql": true,
"searchCount": true,
"optimizeJoinOfCountSql": true,
"countId": "144",
"maxLimit": 247
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/page/list?pageNum=328&pageSize=287
5.4.2. 页面详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 页面详情
Request-headers:
Header | Value | Type | Required | Description | |
---|---|---|---|---|---|
Authorization | string | false | 自定义请求头 - token |
Path-parameters:
Parameter | Value | Type | Required | Description | |
---|---|---|---|---|---|
pageId | int64 | true | 页面id |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 响应状态码 | - |
message | string | 错误消息 | - |
data | object | 响应数据 | - |
└─url | string | 获取访问的url | - |
└─lang | string | No comments found. | - |
└─id | int64 | 主键ID | - |
└─createUserId | int64 | 创建者 | - |
└─title | string | 标题 | - |
└─path | string | 路径 | - |
└─contentHtml | string | 内容 | - |
└─outLink | string | 链接 | - |
└─seoKeywords | string | SEO关键字 | - |
└─seoDescription | string | SEO描述信息 | - |
└─summary | string | 摘要 | - |
└─thumbnail | string | 缩略图 | - |
└─style | string | 样式 | - |
└─status | string | 状态 | - |
└─suffix | string | 页面后缀 | - |
└─viewCount | int32 | 访问量 | - |
└─commentEnable | boolean | 是否开启评论 | - |
└─language | string | 语言 | - |
└─created | string | 创建日期 | - |
└─updated | string | 最后更新日期 | - |
Response-example:
{
"code": 824,
"message": "success",
"data": {
"url": "www.dana-little.us",
"lang": "nfjmaz",
"id": 820,
"createUserId": 846,
"title": "yknxpl",
"path": "sf4gz1",
"contentHtml": "1dm8az",
"outLink": "ye8hc4",
"seoKeywords": "evpcsc",
"seoDescription": "440sat",
"summary": "k7h46p",
"thumbnail": "u7iha5",
"style": "61wr8c",
"status": "da0ax6",
"suffix": "ldue75",
"viewCount": 385,
"commentEnable": true,
"language": "zr3rwe",
"created": "2023-08-14 12:03:44",
"updated": "2023-08-14 12:03:44"
}
}
Curl-example:
curl -X GET -H 'Authorization:token' -i http://127.0.0.1:8080/fastcms/api/client/page/get/460