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

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

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

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

登录模块

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

}

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

相关推荐
swordbob4 小时前
Spring Cloud 5 大组件 · 单个服务开发顺序
后端·spring·spring cloud
道友可好5 小时前
AI 怎么自己跑完一个 6 小时的任务?
前端·人工智能·后端
java1234_小锋5 小时前
Spring Boot 中 Starter 是什么?它的核心规范有哪些?请说明如何自定义一个 Starter。
java·spring boot·后端
雪隐5 小时前
AI股票小助手09-结果展示
人工智能·后端
VitoChang5 小时前
前端也能快速入门后端! NestJS前台和后台的Auth认证
前端·后端
XovH5 小时前
Redis 从入门到精通:性能调优与多语言客户端对比
后端
XovH5 小时前
Redis 从入门到精通:Python + Redis 构建高并发秒杀系统
后端
uhakadotcom5 小时前
结合着 fastapi 使用,anyio 通常可以如何使用 , 它和 uvloop 在性能上有啥差异
后端·面试·github
用户79117724235835 小时前
Claude Code 源码看 Agent 系统设计
后端·agent·ai编程
一个做软件开发的牛马5 小时前
Spring Boot Web 开发实战:RESTful API 设计、统一异常处理、参数校验与拦截器
java·后端