2023年8月1日发(作者：)

API接⼝开发API接⼝开发接⼝⽂档⼀、什么是接⼝⽂档在项⽬开发中，web项⽬的前后端分离开发，app开发，需要由前后端⼯程师共同定义接⼝，编写接⼝⽂档。⼆、接⼝规范是什么？⾸先接⼝分为四部分：⽅法、URL、请求参数、返回参数1、⽅法: 新增(post) 修改(put) 删除(delete) 获取(get)2、URL：以/a开头，如果需要登录才能调⽤的接⼝(如新增、修改；前台的⽤户个⼈信息，资⾦信息等)后⾯需要加/u，即：/a/u；中间⼀般放表名或者能表达这个接⼝的单词；get⽅法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。3、请求参数和返回参数，都分为5列：字段、说明、类型、备注、是否必填。字段是类的属性。说明是中⽂释义。类型是属性类型，只有String、Number、Object、Array四种类型。备注是⼀些解释，或者可以写⼀下例⼦，⽐如负责json结构的情况，最好写上例⼦，好让前端能更好理解。是否必填是字段的是否必填。4、返回参数结构有⼏种情况：1. 如果只返回接⼝调⽤成功还是失败（如新增、删除、修改等），则只有⼀个结构体：code和message两个参数。2. 如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data⾥写返回的参数,data是object类型。3. 如果要返回列表，那么有三个结构体，1是code/mesage/data,data是object，⾥⾯放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list⾥放object，object⾥是具体的参数。注意：URL地址⾥不允许出现⼤写字母，如果是两个单词拼接，⽤/分开。⽰例：请求地址：get /a/student/list请求参数：字段pagesize说明页码⼀页展⽰个数类型NumberNumber备注默认1默认10是否必填否否返回参数：字段codemessagedata说明接⼝状态码接⼝信息类型NumberStringObject备注成功：1 失败：0成功：success 失败：提⽰信息是否必填是是是data：字段pagesizetotalPagelist说明类型备注是否必填是是总页数student listNumberArray是是list：字段idnamegender姓名性别说明类型NumberStringNumber0：男 1：⼥备注是否必填是是