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

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

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

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

登录模块

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

}

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

相关推荐
夕除33 分钟前
spring boot
java·spring boot·后端
smallyoung1 小时前
RAG质量评估全攻略:RAGAS四维指标 + 生产级监控实战
人工智能·后端
yangSnowy1 小时前
mac系统安装hyperf框架swoole扩展
后端·macos·swoole
jiangbo_dev1 小时前
.NET 性能风暴:如何将接口耗时从 2000ms 优化到 15ms(含 PostgreSQL 实战调优)
后端
渐儿1 小时前
Coze Studio 深度文档 06:Eino 与工作流引擎深度
后端
神奇小汤圆2 小时前
Spring Bean 的生命周期
后端
神奇小汤圆2 小时前
我研读了 500 个 Spring Boot 生产级代码库,90% 都犯了这 7 个致命错误
后端
空中海2 小时前
03 MyBatis Spring Boot 集成、事务、测试与工程化体系
spring boot·后端·mybatis
ElonMuscle2 小时前
GO环境速建笔记
后端
用户298698530142 小时前
Java 从零生成 Word 文档:段落、图片与表格操作
java·后端