接口文档

环境管理 eoLinker AMS 提供了目前最强大的 项目环境管理 功能，您可以通过它实现： 一键修改所有API接口的请求前缀（Base URL/根路径） 加上统一Header 加上统一请求参数 通过全局变量动态改变所有接口中的请求参数值等 创建环境 进入环境管理页面，点击添加环境按钮，输入相关的环境名称（如测试环境、生成环境等）： 点击 保存 或 继续添加 即可创建一个新的 项目环境 。 修改环境 鼠标点击需要修改的 环境 ，在右侧直接修改相关的内容，点击保存即可： 删除环境 当鼠标放置于 环境 上时，右侧会出现 隐藏的菜单按钮 ： 点击之后选择 删除 按钮，即可删除该环境： ------------------------------------------------------------------------------------------------------------ 修改根路径（Base Url） eoLinker AMS 提供了目前最强大的 项目环境管理 功能，您可以通过它实现一键修改所有API接口的请求前缀（Base URL/根路径）： 创建环境之后，填写 前置URL 后保存设置： 在 接口列表页面 或 接口详情页 点击页面右上角 切换环境菜单 ，选择想要切换的 环境 ，会发现API的路径已经自动加上环境的前置URL了： --------------

创建接口分组 在eoLinker中，您可以为接口创建相应的分组以方便管理，AMS支持最多二级的接口分组。 创建分组 在API接口页面，点击分组侧边栏上方的 新建分组 按钮： 在弹出框中输入相关信息即可创建一个接口分组： 创建子分组 当鼠标放置于分组上时，右侧会出现 隐藏的菜单按钮 ： 点击之后选择 添加子分组 按钮，在弹出框中输入相关信息即可创建一个接口分组： 为什么不支持更多级分组？ 经过实际的调研，当接口分组超过三级时，接口的管理/搜索效率反而是降低的，因此我们建议您如果项目的接口非常多，分级也比较复杂时，将项目合理拆分为几个项目会更好一些，比如拆分为用户系统、支付系统等。 ------------------------------------------------------------------------------------------------------------ 修改/删除接口分组 当鼠标放置于分组上时，右侧会出现 隐藏的菜单按钮 ： 点击之后选择 修改 或 删除 按钮即可： ------------------------------------------------------------------------------------------------------------ 创建API接口 在项目详情页，点击侧边栏 API接口

前言 每个项目进行研发之前，都会有很多的相对应的文档，当然比较重要的一个就是接口文档，当然接口文档版本也有很多，这边只是把自己写文档的一部分内容写个示例记录一下，方便以后自己查看。当然大家有很好的建议和意见可以关注和留言交流。 设置描述 设计描述，主要是介绍项目接口文档的业务及主要功能介绍，有交互方式、JSON数据交互格式、命名规则等做细分讲解。 1）接口的调用方式： 移动端通过WebService和其他通用的请求方式，调用服务器接口，返回JSON数据。 2）JSON的结构： 请求失败示例 { "status":"0", "message":"您尚未登录，请登录后继续操作" } 请求成功示例 { "status":"1", "message":"", "data":{ "userId":"565562", "userName":"huangxianfeng", "workList":[ { "workId":"245632", "workName":"完成登陆功能的实现" }, { "workId":"956412", "workName":"完成编码的格式转换" } ] } } 字段解析 status：1成功、0失败 message：错误日志，接口访问错误的时候返回的错误提示文字，访问成功 的时候为空 字符串 data：服务器返回的业务数据 3）约定 1