1. 开发规范-RESTful

一. 开发规范

1. 前后端分离开发

在之前的课程中,我们介绍过,现在的企业项目开发有2种开发模式:前后台混合开发前后台分离开发

前后台混合开发,顾名思义就是前台后台代码混在一起开发,如下图所示:

PixPin_2025-04-29_14-59-03.png|500

这种开发模式有如下缺点:

  • 沟通成本高:后台人员发现前端有问题,需要找前端人员修改,前端修改成功,再交给后台人员使用


  • 分工不明确:后台开发人员需要开发后台代码,也需要开发部分前端代码。很难培养专业人才


  • 不便管理:所有的代码都在一个工程中


  • 难以维护:前端代码更新,和后台无关,但是需要整个工程包括后台一起重新打包部署。


所以我们目前基本都是采用的前后台分离开发方式,如下图所示:

PixPin_2025-04-29_14-59-15.png|500

我们将原先的工程分为前端工程和后端工程这2个工程,然后前端工程交给专业的前端人员开发,后端工程交给专业的后端人员开发。

前端页面需要数据,可以通过发送异步请求,从后台工程获取。但是,我们前后台是分开来开发的,那么前端人员怎么知道后台返回数据的格式呢?后端人员开发,怎么知道前端人员需要的数据格式呢?

所以针对这个问题,我们前后台统一制定一套规范!我们前后台开发人员都需要遵循这套规范开发,这就是我们的接口文档

接口文档有离线版和在线版本,接口文档示可以查询今天提供资料/接口文档里面的资料。

那么接口文档的内容怎么来的呢?是我们后台开发者根据产品经理提供的产品原型和需求文档所撰写出来的,产品原型示例可以参考今天提供资料/页面原型里面的资料。

那么基于前后台分离开发的模式下,我们后台开发者开发一个功能的具体流程如何呢?如下图所示:

PixPin_2025-04-29_14-59-26.png|650

  1. 需求分析:首先我们需要阅读需求文档,分析需求,理解需求。


  2. 接口定义:查询接口文档中关于需求的接口的定义,包括地址,参数,响应数据类型等等


  3. 前后台并行开发:各自按照接口文档进行开发,实现需求


  4. 测试:前后台开发完了,各自按照接口文档进行测试


  5. 前后段联调测试:前段工程请求后端工程,测试功能


二. Restful风格

我们的案例是基于当前最为主流的前后端分离模式进行开发。

PixPin_2025-04-29_15-04-37.png|500

在前后端分离的开发模式中,前后端开发人员都需要根据提前定义好的接口文档,来进行前后端功能的开发。

后端开发人员:必须严格遵守提供的接口文档进行后端功能开发(保障开发的功能可以和前端对接)

而在前后端进行交互的时候,我们需要基于当前主流的REST风格的API接口进行交互。

什么是REST风格呢?

  • REST(Representational State Transfer),表述性状态转换,它是一种软件架构风格。

传统URL风格如下:

我们看到,原始的传统URL呢,定义比较复杂,而且将资源的访问行为对外暴露出来了。而且,对于开发人员来说,每一个开发人员都有自己的命名习惯,就拿根据id查询用户信息来说的,不同的开发人员定义的路径可能是这样的:getByIdselectByIdqueryByIdloadById… 。 每一个人都有自己的命名习惯,如果都按照各自的习惯来,一个项目组,几十号或上百号人,那最终开发出来的项目,将会变得难以维护,没有一个统一的标准。

基于REST风格URL如下:

其中总结起来,就一句话:通过URL定位要操作的资源,通过HTTP动词(请求方式)来描述具体的操作。

在REST风格的URL中,通过四种请求方式,来操作数据的增删改查。

  • GET : 查询


  • POST :新增


  • PUT : 修改


  • DELETE :删除


我们看到如果是基于REST风格,定义URL,URL将会更加简洁、更加规范、更加优雅

注意事项:

  • REST是风格,是约定方式,约定不是规定,可以打破


  • 描述模块的功能通常使用复数,也就是加s的格式来描述,表示此类资源,而非单个资源。如:users、emps、books…


三. Apifox

我们上面讲到,在这个案例中,我们将会基于Restful风格的接口进行交互,那么其中就涉及到常见的4中请求方式,包括:POST、DELETE、PUT、GET。

PixPin_2025-04-29_15-05-47.png|500

因为在浏览器地中所发起的所有的请求,都是GET方式的请求。那大家就需要思考两个问题:

  • 前后端都在并行开发,后端开发完对应的接口之后,如何对接口进行请求测试呢?


  • 前后端都在并行开发,前端开发过程中,如何获取到数据,测试页面的渲染展示呢?


那这里我们就可以借助一些接口测试工具,比如项:Postman、Apipost、Apifox等。

PixPin_2025-04-29_15-06-00.png|173

那这些工具的使用基本类似,只不过Apifox工具的功能更强强大、更加完善,所以在课程中,我们会采用功能更为强大的Apifox工具。

1. 介绍

介绍:Apifox是一款集成了Api文档、Api调试、Api Mock、Api测试的一体化协作平台。

作用:接口文档管理、接口请求测试、Mock服务。

官网: https://apifox.com/

PixPin_2025-04-29_15-06-26.png|500

PixPin_2025-04-29_15-06-41.png|500

暂无评论

发送评论 编辑评论


				
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇
下一篇