基于flask实现restfulAPI的完整项目

￡神魔★判官ぃ 2023-06-10 11:27 1阅读 0赞

> 作者：lizhonglin  
> github: https://github.com/Leezhonglin/  
> blog: https://leezhonglin.github.io/

#### 基于flask的restfulAPI项目实现 ####

了解到一段时间的restfulAPI实现，通用面向对象的用户、角色、权限管理的项目案例来阐述是如何实现restfulAPI接口的实现，今天有空来整理一下。

项目中权限是参照标准的RBAC. 来实现，有良好的扩展性。数据库访问、业务层、接口层分离。保障了代码的可扩展性。基于面向对象的思想实现本项目。具体实现见下面介绍。

#### 1、什么是restful？ ####

RESTFUL是一种网络应用程序的设计风格和开发方式，基于[HTTP][]，可以使用[XML][]格式定义或[JSON][]格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方[OTT][]调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。具体详细内容自行百度，并不是本文的重点。

RESTFUL特点包括：

1、每一个URI代表1种资源；

2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源；

3、通过操作资源的表现形式来操作资源；

4、资源的表现形式是XML或者HTML；

5、客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。

> 本项目中主要使用的请求类型的定义：
> 
> GET: 获取资源信息
> 
> POST: 添加资源信息
> 
> PUT: 修改资源信息
> 
> DELETE: 删除资源信息

#### 2、项目目录结构 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70]

#### 3、项目架构图 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 1]

#### 4、项目数据库设计图 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 2]

#### 5、项目具体介绍 ####

##### 5.1 项目URi 定义 #####

# 部门管理
    'http://{host}:{port}/li-boss/<version>/department',
    'http://{host}:{port}/li-boss/<version>/department/<int:dpt_id>'
    
    # 部门人员
    'http://{host}:{port}/li-boss/<version>/department/staff/<int:dpt_id>'
    # 用户
    'http://{host}:{port}/li-boss/<version>/user',
    'http://{host}:{port}/li-boss/<version>/user/<int:user_id>',
    
    # 密码
    'http://{host}:{port}/li-boss/<version>/user/<int:user_id>/password'
    
    # 基本信息修改
    'http://{host}:{port}/li-boss/<version>/user/<int:user_id>/base/info'
    
    # 角色
    'http://{host}:{port}/li-boss/<version>/role',
    'http://{host}:{port}/li-boss/<version>/role/<int:role_id>'
    
    #  角色权限
    'http://{host}:{port}/li-boss/<version>/role/<role_id>/permission'
    
    
    # 权限
    'http://{host}:{port}/li-boss/<version>/permission'
    
    # 用户组
    'http://{host}:{port}/li-boss/<version>/user/group',
    'http://{host}:{port}/li-boss/<version>/user/group/<int:group_id>'
    
    # 用户组成员
    'http://{host}:{port}/li-boss/<version>/user/group/<int:group_id>/staff'
    
    # 获取用户组的角色信息
    'http://{host}:{port}/li-boss/<version>/user/group/<int:group_id>/role'
    
    # 登陆
    'http://{host}:{port}/li-boss/<version>/login'

##### 5.2 项目请求和响应 #####

本项目支持两种数据请求和响应格式。分别是的`JSON`和`XML`.如果需要使用`XML`请求的话需要在URL后面加上　`?format=xml`.就可以正常的获取到`XML`格式的数据。

##### 5.3 请求示例 #####

`JSON`

这是一个`json`请求不需要代`token`的时候的示例：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 3]

加了验证的需要选择`Bearer Token` 验证模式。这是一个`JSON`需要带`token`验证的请求示例：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 4]

`XML`

这是一个`XML`请求不需要代`token`的时候的示例：

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-a0doOuZJ-1572165973312)(/Users/lee/Desktop/Demo/图片/屏幕快照 2019-10-27 16.35.53.png)\]][img-a0doOuZJ-1572165973312_Users_lee_Desktop_Demo_ 2019-10-27 16.35.53.png]

加了验证的需要选择`Bearer Token` 验证模式。这是一个`XML`需要带`token`验证的请求示例：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 5]

#### 6. 具体代码实现 ####

由于本项目代码内容比较多我就不贴代码到这个位置了。详细代码地址放github上面了。[项目地址][Link 1]

自己总计的一些开发经验，与大家分享，如果觉得有用不忘收藏。

####  ####

[HTTP]: https://baike.baidu.com/item/HTTP/243074
[XML]: https://baike.baidu.com/item/XML/86251
[JSON]: https://baike.baidu.com/item/JSON/2462549
[OTT]: https://baike.baidu.com/item/OTT/9960940
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70]: /images/20230531/e76447ac2c9641d29f72af93d27121ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 1]: /images/20230531/df36f664854a45bca0b18db505e94756.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 2]: /images/20230531/27c3d7ce014a44fa851dc22f064e3651.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 3]: /images/20230531/4c7d02bb617041d5a059bffe5fc60eea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 4]: /images/20230531/9be71923ec924dd68fee0ed91955a869.png
[img-a0doOuZJ-1572165973312_Users_lee_Desktop_Demo_ 2019-10-27 16.35.53.png]: /images/20230531/c1a5b2a943c24ddbaff7260776307c0f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTk2ODE0_size_16_color_FFFFFF_t_70 5]: /images/20230531/6b49cd13a8fc451e902e5be52d8a8721.png
[Link 1]: https://github.com/Leezhonglin/user_restful_api