接口文档

来源:互联网 发布:python 登录界面 编辑:程序博客网 时间:2024/05/28 20:19

接口文档编写

简单介绍一下,基本内容分为5个部分

1 业务描述:这个接口的作用


2 调用方式以怎样的方式去调用接口(调用方式有多种,每种调用方式最好做个实例)


3 输入参数:调用接口需要哪些参数({参数名 参数类型 参数描述 说明}   传参实例,一般以json格式入参)


4 返回参数:接口返回值(参数名 参数类型参数描述 说明)


5 异常处理:接口调用时经常会出现哪些异常情况,用try捕捉异常

原创粉丝点击