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

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

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

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

登录模块

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

}

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

相关推荐
我叫黑大帅15 小时前
TCP通信 - 处理 TCP 流中的消息分片
后端·面试·go
卜夋15 小时前
Rust 所有权概念
后端·rust
希望永不加班15 小时前
SpringBoot 依赖管理:BOM 与版本控制
java·spring boot·后端·spring
群书聊架构15 小时前
基于共享内存的高性能 Linux IPC 设计实践(上):从原理到无锁环形缓冲区
后端
落木萧萧82515 小时前
MyBatis、MyBatis-Plus、JPA、MyBatisGX 写法比较:同一个需求,四种解法
java·后端
PFinal社区_南丞15 小时前
为什么我用 Go 写 AI Agent 而不是 Python
后端·go
SimonKing15 小时前
AI大模型中转平台,无需科学上网就可以使用国外模型
java·后端·程序员
IT_陈寒15 小时前
SpringBoot自动配置的坑把我埋了半小时
前端·人工智能·后端
代码漫谈15 小时前
Spring Boot 配置指南:约定大于配置的应用
java·spring boot·后端