20 lines
693 B
Markdown
20 lines
693 B
Markdown
# Gateway Apifox 导入说明
|
||
|
||
- 导入文件：`docs/apifox/gateway-openapi.json`
|
||
- 文件格式：OpenAPI 3.0.3 JSON，Apifox 可直接导入
|
||
- 覆盖范围：当前 `internal/transport/http/server.go` 中全部 HTTP 路由
|
||
|
||
当前已覆盖的接口：
|
||
|
||
- `GET /health`
|
||
- `GET /heath`
|
||
- `GET /ready`
|
||
- `POST /api/v1/users/register`
|
||
- `POST /api/v1/pay`
|
||
|
||
说明：
|
||
|
||
- `/heath` 是兼容历史拼写错误保留的别名，行为与 `/health` 一致。
|
||
- `POST` 接口请求体启用了严格 JSON 校验，文档中已标记 `additionalProperties: false`。
|
||
- 成功响应统一返回 `code`、`message`、`request_id`、`data`；错误响应统一返回 `code`、`message`、`request_id`。
|