Files
wx_service/docs/common/README.md
T

755 B
Raw Blame History

公共说明

本目录存放所有小程序共用的接口约定与调用方式,避免每个子系统重复描述。

基础信息

  • 接口前缀:/api/v1
  • 健康检查:GET /healthz{"status":"ok"}

通用响应结构

本项目所有接口使用统一 JSON 结构(见:docs/common/response.md):

{
  "code": 200,
  "message": "success",
  "data": {}
}

认证方式

除登录接口外,其他接口都需要携带登录后返回的 session_key(见:docs/common/auth.md)。

上传(七牛直传)

  • docs/common/upload_qiniu.md

微信公众号

  • docs/common/wechat_official.md

Redis

  • docs/common/redis.md

自动化部署(非 Docker

  • docs/common/deploy_ci.md