• 博客园logo
  • 会员
  • 周边
  • 新闻
  • 博问
  • 闪存
  • 众包
  • 赞助商
  • Chat2DB
    • 搜索
      所有博客
    • 搜索
      当前博客
  • 写随笔 我的博客 短消息 简洁模式
    用户头像
    我的博客 我的园子 账号设置 会员中心 简洁模式 ... 退出登录
    注册 登录
漫椿
博客园    首页    新随笔    联系   管理    订阅  订阅
后台接口文档实例

  什么是接口文档

  1用于前后端交互,必须前端人员和后端人员共同定义API接口

  接口文档规范

  1.方法:C R U D

  2.url:调用方法就是从前端调用后端的方法地址

  3请求参数:一般分为字段、说明、类型、备注、是否必填

  4返回的参数

    4.1如果直接返回接口调用的成功与失败(R U D),就只有一个结构体,code(返回的状态值)和message(返回是一个字符串成功/失败)两个参数;

    4.2如果要返回某些参数。则有两个结构体code/message/data(返回的参数数据)

    4.3如果返回的是一个列表则有三个结构体分别是code/message/data,data和一个object类型的数据,第二个data中放置的是分页的一些数据

 

  

posted on 2022-05-13 15:35  编程耽误的厨子  阅读(600)  评论(0)    收藏  举报
刷新页面返回顶部
博客园  ©  2004-2026
浙公网安备 33010602011771号 浙ICP备2021040463号-3