接口文档怎么看【学习】什么是接⼝⽂档，如何写接⼝，有什么规范？
⼀、什么是接⼝⽂档？
在项⽬开发中，web项⽬的前后端分离开发，APP开发，需要由前后端⼯程师共同定义接⼝，编写接⼝⽂档，之后⼤家都根据这个接⼝⽂档进⾏开发，到项⽬结束前都要⼀直维护。
⼆、为什么要写接⼝⽂档？
1、项⽬开发过程中前后端⼯程师有⼀个统⼀的⽂件进⾏沟通交流开发
2、项⽬维护中或者项⽬⼈员更迭，⽅便后期⼈员查看、维护
三、接⼝规范是什么？
⾸先接⼝分为四部分：⽅法、uri、请求参数、返回参数
1、⽅法：新增(post) 修改(put) 删除(delete) 获取(get)
2、uri：以/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⾥是具体的参数。
注意：uri地址⾥不允许出现⼤写字母，如果是两个单词拼接，⽤/分开
四、如何导⼊/导出接⼝⽂档
Eolinker是我⽤了4年的接⼝⼯具，⽀持接⼝⽂档多格式的导⼊和导出，可以直接在上⾯进⾏API的开发，可以⾃⼰在线使⽤试试：

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。