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

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

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

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

登录模块

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

}

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

相关推荐
w***74404 小时前
SpringBoot项目如何导入外部jar包:详细指南
spring boot·后端·jar
tsumikistep5 小时前
【前后端】接口文档与导入
前端·后端·python·硬件架构
码事漫谈6 小时前
为什么C语言拒绝函数重载?非要重载怎么做?
后端
码事漫谈6 小时前
浅谈C++与C语言二进制文件差异(从一次链接错误说起)
后端
空白诗8 小时前
mdcat 在 HarmonyOS 上的构建与适配
后端·安全·华为·rust·harmonyos
y***61318 小时前
SpringBoot集成Flowable
java·spring boot·后端
i***22079 小时前
springboot整合libreoffice(两种方式,使用本地和远程的libreoffice);docker中同时部署应用和libreoffice
spring boot·后端·docker
e***87709 小时前
windows配置永久路由
android·前端·后端
代码or搬砖9 小时前
SpringMVC的执行流程
java·spring boot·后端