文档

基础信息配置

更新时间:

根据不同类型的 API 服务,编辑相应的参数值:

  • HTTP API

    • API 名称:必填,该 API 的接口名称,方便后续维护。

    • 接口描述:选填,更详细的 API 描述。

    • 接入系统:必填,API 所属的业务系统。

    • 请求 Path:必填,URL Path,可使用 ${} 包含 path 参数,比如:/pets/${id}

    • 请求方式:必填,支持 GET、POST、PUT、DELETE 和 HEAD。

    • 报文编码:必填,UTF-8 或 GBK 格式。

  • MPC API

    • API 名称:必填,该 API 的接口名称,方便后续维护。

    • 接口描述:选填,更详细的 API 描述。

    • 接入系统:API 所属的业务系统。

    • 接口方法:API 服务端方法。

    • 接口名称:API 服务端接口。