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

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

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

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

登录模块

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

}

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

相关推荐
李慕婉学姐1 小时前
Springboot平安超市商品管理系统6sytj3w6(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。
数据库·spring boot·后端
PRINT!1 小时前
RabbitMQ实战项目(含代码仓库地址+视频教程地址)基本篇已更新完结,高级篇持续更新中
java·分布式·后端·微服务·rabbitmq
小心草里有鬼2 小时前
VMware虚拟机扩容
linux·后端·centos·vim
大魔王7193 小时前
进程线程和协程三
后端
感性的程序员小王3 小时前
我做了个 AI + 实时协作 的 draw.io,免费开源!!
前端·后端
那我掉的头发算什么4 小时前
【SpringBoot】统一功能处理详解
java·spring boot·后端·spring
rlpp4 小时前
spring.profiles.active和spring.profiles.include的使用及区别说明
java·后端·spring
小小张说故事5 小时前
Python图像处理利器:Pillow (PIL)入门指南
后端·python·图像识别
DevDengChao5 小时前
[Aliyun] [FC] 如何使用 website-fc-serve 插件部署静态网站
前端·后端