API接口文档编写

什么是API接口文档

1. API 的入参、出参的格式

为什么要编写API接口文档

1 有利于客户端工程师熟悉接口
2有利于服务端工程师接受项目

怎么写API接口文档

1 word、PDF、wiki

需要包含那些内容

api 接口地址
请求方式 get(查询) 、post(创建)、 put(更新)、 delete(删除)
入参格式
出参格式
http code

例子 — 栏目接口

如下图所示：
header 参数作为基准的参数，每次请求都要带上
api 借口地址
host:
测试域名：localhost/tp5
线上域名：tzf.com
1、借口地址：api/v1/catogory
2、请求方式：get
3、请求参数 header 头的基本参数
http code： 200 、400 500
接口返回
cat_id cat_name status
例如：
data:[
{ cat_id:1,
cat_name:首页,
statis:1
}
]