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

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

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

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

登录模块

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

}

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

相关推荐
EatFan28 分钟前
Spring Boot 4 落地观察:从 yudao-cloud、matecloud、JPower 看国产脚手架的升级路线与迁移清单
java·spring boot·后端·spring cloud·微服务·后端开发·jdk 21
波力海苔夹心脆6752 小时前
C# 序列化与反序列化详解:System.Text.Json、Newtonsoft.Json、XmlSerializer 用法、特性选项与安全实践
经验分享·后端·c#·json·.net
JavaGuide3 小时前
NVIDIA 又开源了!这次给 AI Agent 加上权限管控
前端·后端
excel3 小时前
prisma 如何处理数据库竞态
前端·数据库·后端
IT_陈寒5 小时前
Java线程池这破玩意,差点让我周末加班排查到凌晨
前端·人工智能·后端
弈栈录6 小时前
Java AI 应用的异步化与高并发设计
java·后端·架构
凤山老林7 小时前
Spring Boot 集成 iText 7 实现动态 PDF 生成与电子签章:合同、报表场景实战
spring boot·后端·pdf·itext7·电子签章
孙启超7 小时前
【AI开发之Rust】第 19 课:UniFFI 导出核心能力
开发语言·后端·rust
ServBay7 小时前
基于Jev的浏览器Agent插件狂揽 21k star,3分钟教你解放双手
后端·aigc·ai编程