分布式组件发布接口文档模板模板.pdfVIP

附件2-API接口文档示例

整体功能介绍

【内容】

重点描述各个接口的调用顺序以及各接口之间的约

束，接口方式（批处理、逐条；本地、远程；远程提

供传输方式等）。适当的可以配以流程图说明。

接口详情

**接口

（一）接口功能

【内容】重点描述该接口的实现功能

（二）请求方向

【内容】重点标明接口的调用方向

（三）使用说明

【内容】重点描述接口的使用的前置条件，约束条件以及各

种注意事项。

（四）接口类型

请求POST/GET

方法

访问如果是Dcoos注册，要写在Dcoos注册完的

URL调用地址，如果是独立网关接入，调用地址是

独立网关提供出来的调用地址。需求方是要从

这个地址进行调用。

协议HTTP/HTTPS

（五）请求参数

参数名是否必参数类说明

称