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
请求参数：

字段

说明

类型

备注

是否必填

page

页码

Number

默认1

否

size

一页展示个数

Number

默认10

否

返回参数：

字段

说明

类型

备注

是否必填

code

接口状态码

Number

成功：1 失败：0

是

message

接口信息

String

成功：success 失败：提示信息

是

data

Object

是

data：

字段

说明

类型

备注

是否必填

page

是

size

是

totalPage

总页数

Number

是

list

student list

Array

是

list：

字段

说明

类型

备注

是否必填

id

Number

是

name

姓名

String

是

gender

性别

Number

0：男 1：女