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,25 @@
|
||||
# 公共说明
|
||||
|
||||
本目录存放所有小程序共用的接口约定与调用方式,避免每个子系统重复描述。
|
||||
|
||||
## 基础信息
|
||||
|
||||
- 接口前缀:`/api/v1`
|
||||
- 健康检查:`GET /healthz` → `{"status":"ok"}`
|
||||
|
||||
## 通用响应结构
|
||||
|
||||
本项目所有接口使用统一 JSON 结构(见:`docs/common/response.md`):
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"message": "success",
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
|
||||
## 认证方式
|
||||
|
||||
除登录接口外,其他接口都需要携带登录后返回的 `session_key`(见:`docs/common/auth.md`)。
|
||||
|
||||
Reference in New Issue
Block a user