如何撰写产品需求接口文档?

之前一直没涉及到接口文档,现在临时需要写一份接口文档,请问该怎么写?怎么判断哪里需要请求接口呢?
已邀请:
俊临天下

俊临天下 - 长的太帅也很烦呐,真他妈烦

赞同来自:

1、接口文档要看公司的情况,有些公司的接口是java直接鉴权(决定访问权),有些公司是PHP+java组合,鉴权由PHP负责处理,有些公司又不一定,所以先看下公司的接口的情况是怎么回事,这个和开发童鞋沟通一下就知道了


2、接口分查询和更新(GET/POST),

3、核心还是在于出入参,比方说入参是什么,出参是什么,比方说提交管理员手机号码,可以获得相关的返回参数,对于技术而言,这个需要明确下来。

4、接口功能明确下来之后,还要落实是否满足需求(找老大审核)

5、后续联调也是大坑,慢慢填吧
Cy

Cy - 剽悍的人生不需要解释

赞同来自:

把以下的类目说明写好:

一、 接口功能 (功能说明)

1、实现功能接口清单 (主要包括详细接口名称和对应接口实现功能)

2、接口详细描述(接口名称 ,请求方法,请求URI, 请求消息,响应消息,返回码清单)

3、 接口调用时序图

二、代码样例(比如J**A,PHP,Javascript等等)

我唯一一次写的需求接口文档就写了上述的内容,希望能帮助到你。

参与讨论请先登录注册