API 列表

HTTP 状态码说明

本 API 遵循 RESTful 设计规范，使用标准 HTTP 状态码表示请求结果。

成功状态码

状态码	描述	使用场景
200	OK	请求成功，返回请求的数据
201	Created	资源创建成功
204	No Content	请求成功，但无返回内容（如删除操作）

客户端错误状态码

状态码	描述	使用场景
400	Bad Request	请求参数错误或格式不正确
401	Unauthorized	未授权，需要身份验证
403	Forbidden	已授权但无权限访问该资源
404	Not Found	请求的资源不存在
409	Conflict	请求与当前资源状态冲突
422	Unprocessable Entity	请求格式正确但语义错误

服务器错误状态码

状态码	描述	使用场景
500	Internal Server Error	服务器内部错误
502	Bad Gateway	网关错误
503	Service Unavailable	服务暂时不可用

错误响应格式

当请求失败时，响应体将包含以下格式的错误信息：

{
    "message": "错误描述信息",
}

API 地址

https://mpusher.bugcode.dev

完整地址示例:

https://mpusher.bugcode.dev/public-api/subscriptions

API 鉴权

API 鉴权方式采用 Bearer Token 方式，在每个 API 请求时请务必携带。示例:

{
    "Authorization": "Bearer {your_token}"
}

查询订阅的公众号列表(GET)

path: /subscriptions

Query 参数:

参数名称	参数类型	是否必传	默认值	描述
page	String	❌	1	页码
pageSize	String	❌	10	每页记录数(最大100)
mpName	String	❌		搜索的公众号名称

响应参数:

参数名称	参数类型	是否必传	默认值	描述
items	array[object]	✅		公众号列表
mpId	Integer	✅		公众号ID
mpName	String	✅		公众号名称
total	Integer	✅		总记录数
page	Integer	✅		当前页码
pageSize	Integer	✅		每页记录数

HTTP状态码:

• 200 OK - 查询成功
• 400 Bad Request - 请求参数错误（如pageSize超过100）

成功响应示例 (200):

{
    "items": [
        {
            "mpId": 1201153928,
            "mpName": "新闻1"
        },
        {
            "mpId": 1201153929,
            "mpName": "新闻2"
        },
        {
            "mpId": 1201153930,
            "mpName": "新闻3"
        }
    ],
    "total": 9,
    "page": 1,
    "pageSize": 10
}

错误响应示例 (400):

{
    "message": "pageSize不能超过100"
}

通过文章 URL 订阅公众号(POST)

path: /subscriptions/by-article-url

请求参数:

参数名称	参数类型	是否必传	默认值	描述
articleUrl	String	✅		微信公众号文章URL

请求示例:

{
    "articleUrl": "https://mp.weixin.qq.com/s/xxxxxxxxx"
}

响应参数:

参数名称	参数类型	是否必传	默认值	描述
data	Object	✅		响应数据
mpId	Integer	✅		公众号ID
mpName	String	✅		公众号名称
message	String	✅		响应描述

HTTP状态码:

• 201 Created - 订阅成功
• 400 Bad Request - 请求参数错误（如URL格式不正确）
• 404 Not Found - 文章不存在或无法访问
• 409 Conflict - 已订阅该公众号

成功响应示例 (201):

{
    "data": {
        "mpId": 1201153931,
        "mpName": "新订阅的公众号"
    },
    "message": "订阅成功"
}

错误响应示例 (400):

{
    "message": "文章URL格式不正确"
}

错误响应示例 (409):

{
    "message": "该公众号已订阅"
}

取消订阅公众号(DELETE)

path: /subscriptions

请求参数:

参数名称	参数类型	是否必传	默认值	描述
mpId	Integer	✅		公众号ID

请求示例:

{
    "mpId": 1201153931
}

HTTP状态码:

• 204 No Content - 取消订阅成功
• 400 Bad Request - 请求参数错误
• 404 Not Found - 公众号不存在或未订阅

成功响应示例 (204):

无响应体内容

错误响应示例 (404):

{
    "message": "公众号不存在或未订阅"
}

错误响应示例 (400):

{
    "message": "mpId不能为空"
}

设置文章推送地址(PUT)

path: /config/callback

请求参数:

参数名称	参数类型	是否必传	默认值	描述
callbackUrl	String	✅		回调URL地址
authToken	String	❌		认证令牌(可选)

请求示例:

{
    "callbackUrl": "https://your-domain.com/webhook",
    "authToken": "your-auth-token"
}

响应参数:

参数名称	参数类型	是否必传	默认值	描述
message	String	✅		响应描述

HTTP状态码:

• 200 OK - 配置更新成功
• 400 Bad Request - 请求参数错误（如URL格式不正确）

成功响应示例 (200):

{
    "message": "配置更新成功"
}

错误响应示例 (400):

{
    "message": "回调URL格式不正确"
}