首页 > 编程知识 正文

开发中接口文档谁来写(接口需求文档模板)

时间:2023-05-05 11:43:40 阅读:76433 作者:3430

首先,我想我需要知道后端接口设计文档,我个人需要知道接口调用方的内容 博客地址:芒果橙子个人博客【http://mangocheng.com】 界面设计说明-xx系统修改记录每次更新时都会删除此次修改记录,初步内容日期:2020-05-01~2020-05-06 1 .新权限模块第3章内容界面清单号模块说明1权限模块主要包括用户权限功能接口1、权限模块号接口说明1searchAuthority当前登录的权限http://www 参数类型未明确,默认均为字符串1 .获取用户权限1 )功能说明获取当前登录的权限、菜单加功能 2 )接口说明请求方式(GET请求地址) http://IP :端口/authority/search authority请求参数)无)3)请求参数http://www . 335810.254.11.823358搜索属性4 )响应参数名称类型说明dataMap权限对象statusString状态:1-成功、 0-失败httpCodeStringHttp返回代码errCodeString错误代码errMessageString错误消息http://www.Sina.com/{ ' status ' :' data ' ' errCode': 0,' errMessage': ''} 2.保存或更新菜单1 )管理功能说明菜单、添加或更新菜单 2 )接口说明请求方式) POST请求地址(http://IP : port/authority/saveorupdatemenu请求参数) menuVO 3)请求参数预定义更新–更新(menuPOTMenuPO菜单实体类http://www.Sina.com/(menupo ) : )、id (: )、name (: )菜单名称1 )、' typpo {'menupo':{'id':'23欢呼的宝马,' name': '菜单名称23' } 'type': 'UPDATE'} 4)响应参数名称泰国更新结果主键集(ryid )状态字符串状态:1-成功,0-失败的httpCodeStringHttp返回代码错误代码错误消息errMessageString错误消息http://www. ' data ' : [ ' 24480 ] ' errcode ' :' errmessage ' : ' ' } http://www.Sina.com/{ ' status ' :' data } 序列号接口说明1xxxx 示例 预定义的默认通用说明1. xx接口1 )功能说明接口的功能是什么 2 )接口说明请求方式) GET/POST请求地址)接口地址请求参数)方法参数名称3 )请求参数接口的请求参数说明 示例请求参数示例4 )响应参数接口的响应参数说明 参数名称类型说明xxxxx

x MenuVO:菜单对象响应参数示例

版权声明:该文观点仅代表作者本人。处理文章:请发送邮件至 三1五14八八95#扣扣.com 举报,一经查实,本站将立刻删除。