聚美优品网站建设策划书坑梓网站建设如何

聚美优品网站建设策划书,坑梓网站建设如何,wordpress 虚拟主机 推荐,网站怎么写文章目录一、接口文档1.1 接口文档介绍1.2 接口文档内容二、接口文档解析2.1 登录接口文档2.1.1 基本信息2.1.2 请求参数2.1.3 返回数据2.2 登录接口文档解析一、接口文档 1.1 接口文档介绍 接口文档#xff1a;又称为API文档#xff0c;一般是由后端开发人员所编写的…文章目录一、接口文档1.1 接口文档介绍1.2 接口文档内容二、接口文档解析2.1 登录接口文档2.1.1 基本信息2.1.2 请求参数2.1.3 返回数据2.2 登录接口文档解析一、接口文档1.1 接口文档介绍接口文档又称为API文档一般是由后端开发人员所编写的用来描述系统所提供接口信息的文档。1、为什么要写接口文档 - 能够让前端开发与后端开发人员更好的配合提高工作效率。(有一个统一参考的文件) - 项目迭代或者项目人员更迭时方便后期人员查看和维护。 - 方便测试人员进行接口测试。 2、展现形式 - word 文档形式 - Excel 表格式形式 - pdf 文档形式。1.2 接口文档内容一个规范的接口文档要包含以下信息1、基本信息资源路径协议和域名在 “系统信息”中请求方法接口描述2、请求参数请求头Content-Type。描述请求体的数据类型请求体包含具体的请求参数名称、参数类型、是否必须、示例、备注3、返回数据不同情况的响应状态码成功响应数据包含具体的响应数据名称、类型、是否必须、默认值、示例、备注)二、接口文档解析2.1 登录接口文档2.1.1 基本信息Path http://ihrm2-test.itheima.net/api/sys/loginMethod POST接口描述:2.1.2 请求参数Headers参数名称参数值是否必须示例备注Content-Typeapplication/json是Body名称类是否必须默认值备注其他信息mobilestring必须手机号passwordstring必须密码2.1.3 返回数据操作成功响应状态码200错误码描述10000操作成功20001用户名或密码错误99999抱歉系统繁忙请稍后重试名称类型是否必须默认值备注successbool是操作成功标记codeint是10000错误码messagestring是操作成功消息datastring是令牌token{success:true,code:10000,message:操作成功,data:xxx}{success:false,code:20001,message:用户名或密码错误,data:null}{success:false,code:99999,message:抱歉系统繁忙请稍后重试,data:null}2.2 登录接口文档解析接口文档的解析本质从接口文档中找出 http 请求所需要的 数据信息。1、http请求相关数据 ——①请求方法 ——②URL ——③请求头 ——④请求体数据类型 2、http响应相关数据预期结果 ——①响应状态码 ——②响应体以 “登录” 为例请求方法POSTURLhttp://ihrm2-test.itheima.net/api/sys/login请求头Content-Type:application/json请求体{“mobile”:”13800000002”, “password”:”888itcast.CN764%…”}响应状态码200错误码10000操作成功20001用户名或密码错误99999抱歉系统繁忙请稍后重试