后端总指挥---文件接口

为了方便编写项目时前后端的连接,在这里引进文件接口的概念,通常包含以下几个部分:

  • 功能
  • 请求路径
  • 请求方式
  • 传输的数据类型
  • 请求入参
  • 数据样本
  • 响应的出参
  • 响应成功后的数据样本

这样前端编程与后端编程 可以根据文件接口这个文档来分别编写前后端,以下给出一个实例:

登录模块

1.注册功能

作用:用于用户注册

请求路径:UserRegister

请求方式:post

传输的数据类型:json

请求入参:

id(用户id): 类型:字符串*

account(账号) 类型:字符串*

password(密码) 类型:字符串*

数据样本:

{

"id":"1001"

"account":"admin",

"password":"123456"

}

响应的出参:

code(状态) 类型: 整数*

message(信息) 类型:字符串*

注册成功后数据样本:

{

"code":1,

"message":"账号已经存在"

}

{

"code":0,

"message":"注册成功"

}

{

"code":-1,

"message":"注册失败"

}

知道以上概念后,就可以将项目后端需要实现的功能分门别类的写成如上模式。

相关推荐
Csvn8 分钟前
Day 3:LIKE 与模式匹配 — 让查询学会"模糊搜索"
后端·sql
Hazenix1 小时前
Go 指南:一篇文章速通 Golang
开发语言·后端·golang
灯澜忆梦1 小时前
GO_复合类型---指针
开发语言·后端·golang
IT_陈寒2 小时前
SpringBoot自动装配坑了我一天,原来问题出在这
前端·人工智能·后端
星栈2 小时前
深度复盘:比 EventLoop 更隐蔽!Node 微任务堆积引发的线上接口雪崩事故
后端·node.js
名字还没想好☜3 小时前
Go slice 的 append 陷阱:共享底层数组导致的数据串改
开发语言·后端·golang·go·slice
诸神缄默不语3 小时前
FastAPI后端配置CORS中间件支持浏览器跨域访问
后端·fastapi
Fanta丶3 小时前
14.Activiti7 网关 排他网关ExclusiveGateway、并行网关ParallelGateway
后端
明月_清风3 小时前
robots.txt 完全指南:从入门到精通
后端·爬虫
jvmind_dev3 小时前
Java GC 实战指南(番外篇):被忽视的隐形杀手 —— Class Unloading 如何拖垮 GC
java·后端