1.什么是接口文档？

  • 在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

2.为什么需要写接口文档？

  • 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
  • 项目维护中或者项目人员更迭，方便后期人员查看、维护

3.什么情况下需要接口文档？

  • 远程协作开发。远程开发，这种情况下是需要的
  • 面对面开发。开发节奏不一致，所以需要接口文档
  • 接手别人项目。刚进来不熟悉，所以需要接口文档

4.接口文档怎么写，规范是什么？

首先接口分为四部分：请求方法、请求地址、请求参数、返回参数

  • 请求方法:
  • 新增(post) ，修改(put) ，删除(delete) ，获取(get)
  • 请求地址：
  • 以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。
  • 请求参数和返回参数
  • 都分为5列：字段、说明、类型、备注、是否必填
    字段是类的属性；说明是中文释义；类型是属性类型，只有String、Number、Object、Array四种类型；备注是一些解释，或者可以写一下例子，比如负责json结构的情况，最好写上例子，好让前端能更好理解；是否必填是字段的是否必填。
  • 返回参数结构有几种情况
  • 1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；2、如果要返回某些参数，则有两个结构体：一个是code/mesage/data，另一个是data里写返回的参数,data是object类型；3、如果要返回列表，那么有三个结构体，一个是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。

5.接口文档的常用工具？

  • 易文档，石墨文档，eolinker，Yapi等，当然记事本也是可以的，只是不方便编写，共享等

6.什么时候写接口文档？

  • 我们的做法是：
    1.前后端先过需求，然后制定出需要哪些接口，制定接口规范
    2.服务端给出json报文，标明各个字段含义，并给出模拟api
    3.然后客户端就可以开始先做功能，调用模拟api
    4.前后端开发大体完成，进入集成测试，期间接口会做加减法，但是变动不大
  • 以上，是基于有个好的架构负责梳理业务流程，毕竟先给出接口文档和模拟API的是对业务流程把握的考验，开发期间，有问题应该主动沟通，或者是每天上班开个几分钟晨会，报一下进度，还有反馈可能觉得出现的情况。

7.一般接口文档是谁来写的？
在项目开发中，前后端是分离的，为了前后端的连贯性，一般由前后端工程师共同定义接口，编写接口文档