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

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

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

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

登录模块

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

}

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

相关推荐
AskHarries1 小时前
GitHub 登录配置流程
后端
Sinclair3 小时前
安企CMS的安装-常见安装问题排查
运维·后端
Sinclair4 小时前
安企CMS的安装-安装引导与初始化
运维·后端
Sinclair4 小时前
安企CMS的安装-源码编译安装
运维·后端·go
Sinclair4 小时前
安企CMS的安装-同一服务器多站点部署
运维·后端
Sinclair4 小时前
安企CMS的安装-服务器手动部署
运维·后端
Sinclair4 小时前
安企CMS的安装-PHPStudy(小皮面板)部署
前端·后端
Sinclair4 小时前
安企CMS的安装-宝塔面板部署
服务器·后端
会飞的特洛伊4 小时前
IAM身份认证
前端·后端
开飞机的舒克_4 小时前
FastAPI 异步 ORM 实战:从核心特性到图书 CRUD 最佳实践
后端