项目开发流程

接口文档

⼀、什么是接口文档？

在项⽬开发中，web项⽬的前后端分离开发，APP开发，需要由前后端⼯程师共同定义接⼝，编写接⼝
⽂档，之后⼤家都根据这个接⼝⽂档进⾏开发，到项⽬结束前都要⼀直维护。

⼆、为什么要写接口文档？

1、项⽬开发过程中前后端⼯程师有⼀个统⼀的⽂件进⾏沟通交流开发
2、项⽬维护中或者项⽬⼈员更迭，⽅便后期⼈员查看、维护

三、接口规范是什么？
⾸先接口分为四部分：方法、url、请求参数、返回参数

• 方法
• url
• 请求参数
• 返回参数
  

数据字典