Update documentation structure and enhance API descriptions
- Revised README.md to provide a clearer documentation structure for multiple mini programs, including a new table of contents. - Added references to common authentication documentation in both the remove watermark API and README files. - Improved clarity of the login interface description and error handling messages in the remove watermark API documentation.
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
# 通用响应与错误
|
||||
|
||||
## 通用响应结构
|
||||
|
||||
所有接口响应结构:
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"message": "success",
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
|
||||
- `code`:业务码(本项目中与 HTTP 状态码保持一致)
|
||||
- `message`:提示信息(部分接口为中文提示)
|
||||
- `data`:成功时返回的数据,失败时通常省略
|
||||
|
||||
## 常见 HTTP 状态码
|
||||
|
||||
- `200`:成功
|
||||
- `400`:请求参数错误
|
||||
- `401`:未登录或登录已过期(缺少/无效 Token)
|
||||
- `403`:无权限或触发业务限制(例如今日额度用尽)
|
||||
- `404`:资源不存在
|
||||
- `500`:服务端内部错误
|
||||
- `502`:第三方服务错误
|
||||
- `503`:服务暂不可用(缺少关键配置等)
|
||||
|
||||
Reference in New Issue
Block a user