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

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

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

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

登录模块

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":"注册失败"

}

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

相关推荐
guchen66几秒前
异步编程优化:从底层源码看最佳实践
后端
小码哥_常2 分钟前
Spring Boot异常处理:别被@RestControllerAdvice“坑”了!
后端
金銀銅鐵2 分钟前
Byte Buddy 生成的类的结构如何?(第二篇)
java·后端
几许3 分钟前
高并发有序顺序号生成中间件 - 架构设计文档
java·后端
小码哥_常4 分钟前
Spring Boot 邂逅Elasticsearch:打造搜索“光速引擎”
后端
南方的耳朵9 分钟前
OpenStack neutron vlan+bridge构建vpc网络时同子网虚拟机跨节点互通过程细节分析
后端
程序员Terry13 分钟前
Docker 部署 RocketMQ 5.1.0 踩坑实录:从超时到 Console 连不上的完整解决之路
java·后端
tsyjjOvO16 分钟前
SpringMVC 从入门到精通(续)
java·后端·spring
Binary-Jeff16 分钟前
MySQL MVCC 原理解析:Undo Log、ReadView 与版本可见性机制
java·数据库·后端·mysql·spring