CN109981620A - 一种后台接口管理系统 - Google Patents

Abstract

本发明公开一种后台接口管理系统，涉及权限管理技术领域；基于yapi，还包括权限管理模块、项目管理模块、接口管理模块，权限管理模块用于实现人员的权限控制，项目管理模块用于项目的配置及管理，接口管理模块用于项目的接口配置及管理，权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

Description

一种后台接口管理系统

技术领域

本发明公开一种后台接口管理系统，涉及权限管理技术领域。

背景技术

随着Web技术的发展，前后端分离构架变的越来越流行。前端负责数据的展现和交互，提高了开发效率，但存在一些问题：对于前端工程师，后端提供的接口文档大多是不规范的，后端接口经常遇到接口因未知原因增加参数了，参数名变了，参数被删除了等问题。对于后端工程师，接口对接时总是需要写冗杂繁琐的文档，需要大量时间去维护接口文档。而现有的基于yapi的api管理系统，可管理api以及mock数据，但是不可直接生成接口。

本发明提供一种后台接口管理系统，简化代码开发，提高编程效率。只需要部署好该系统，便可以提供非常简便的后台接口开发，本系统将接口的处理规则在更底层实现，接口的编写变得极为简单，使接口编写不再成为后台开发人员工作，只要有权限，不同层次的人员均能够参与项目，皆可开发。

发明内容

本发明针对现有技术的问题，提供一种后台接口管理系统，旨在为开发、测试人员提供接口管理服务，可以帮助开发者轻松创建、发布、维护api,并可以在前端完成数据源的配置，以及接口的编写及发布等服务。

本发明提出的具体方案是：

一种后台接口管理系统，基于yapi，还包括权限管理模块、项目管理模块、接口管理模块，

权限管理模块用于实现人员的权限控制，项目管理模块用于项目的配置及管理，接口管理模块用于项目的接口配置及管理，

权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

所述的系统中各级管理员分别是超级管理员、组长及组员，权限管理模块控制最高权限给超级管理员，超级管理员管理组长的权限，组长管理组员的权限。

所述的系统中组长通过权限管理模块分配组员在项目中可处理的相应操作权限及对项目中的接口信息进行编辑的权限。

所述的系统中组员获得权限管理模块相应的权限，对项目的相应操作包括insert操作、drop操作、select操作中的一种或几种。

所述的系统中组员通过接口管理模块对项目中的接口信息，在项目前期编写接口地址，参数，返回值，mock数据供开发者使用，在项目后期编写与接口生成相关的规则，接口管理模块根据接口生成相关的规则生成接口。

所述的系统中组员通过接口管理模块编辑的接口生成相关的规则包括接口参数规则、数据选取规则及返回值规则。

所述的系统中还包括测试模块，用于测试生成的接口是否正确。

所述的系统中测试模块利用postman工具对生成的接口进行测试。

一种后台接口管理系统的使用方法，利用所述的系统，

使用权限管理模块实现人员的权限控制，使用项目管理模块进行项目的配置及管理，使用接口管理模块进行项目的接口配置及管理，

其中利用权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

本发明的有益之处是：

本发明提供一种后台接口管理系统，基于yapi，还包括权限管理模块、项目管理模块、接口管理模块，权限管理模块用于实现人员的权限控制，项目管理模块用于项目的配置及管理，接口管理模块用于项目的接口配置及管理，权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理；本发明系统改进yapi，新增了实际接口的管理编写，使接口的编写在前端通过简单的输入、选择即可实现，简化代码开发，使接口开发更为简单，提高编程效率，另外，部署好该系统，便可以提供非常简便的后台接口开发，本系统将接口的处理规则在更底层实现，接口的编写变得极为简单，使接口编写不再成为后台开发人员工作，架构面向不同的用户，只要有权限，不同层次的人员均能够参与项目。

附图说明

图1是本发明方法流程示意图；

图2本发明超级管理员权限分配过程示意图；

图3本发明组长权限分配过程示意图；

图4本发明组员进行接口编辑的过程示意图；

图5测试模块测试准备过程示意图。

具体实施方式

本发明提供一种后台接口管理系统，基于yapi，还包括权限管理模块、项目管理模块、接口管理模块，

权限管理模块用于实现人员的权限控制，项目管理模块用于项目的配置及管理，接口管理模块用于项目的接口配置及管理，

权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

同时提供与上述系统相应的一种后台接口管理系统的使用方法，利用所述的系统，

使用权限管理模块实现人员的权限控制，使用项目管理模块进行项目的配置及管理，使用接口管理模块进行项目的接口配置及管理，

其中利用权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

下面结合附图和具体实施例对本发明作进一步说明，以使本领域的技术人员可以更好地理解本发明并能予以实施，但所举实施例不作为对本发明的限定。

基于yapi，本发明系统中还包括权限管理模块、项目管理模块、接口管理模块，各级管理员分别是超级管理员、组长及组员，

利用本发明系统及其使用方法，某企业用户对项目及项目接口进行开发，具体过程为：

步骤1：权限管理模块控制最高权限给超级管理员，超级管理员新建账号，分配账号权限给组长，

步骤2：组长创建项目，组长管理接口各大分组与项目，编写项目信息，可在项目管理模块中配置项目的名称、数据源信息等，为项目分配组员，为组员分配操作权限，即组长通过权限管理模块分配组员在项目中可处理的相应操作权限及对项目中的接口信息进行编辑的权限，

步骤:3：组员获得权限管理模块相应的权限，对项目进行相应操作，比如是否可执行insert、drop等操作还是只能执行select操作，

组员以及有限权查看的项目中的接口信息，编辑接口，组员通过接口管理模块对项目中的接口信息，在项目前期编写接口地址，参数，返回值，mock数据供开发者使用，在项目后期编写与接口生成相关的规则，接口生成相关的规则包括接口参数规则、数据选取规则及返回值规则等，

接口参数规则规定某参数在数据库中对应哪个表中的哪个字段，并且编辑某个参数时，编辑所在表只能为一张表，编辑字段只能为一个字段，

数据选取规则规定应该按照什么规则取数或者排序，

返回值规则规定某返回值应该选取的字段，选取的字段应该按照什么规则生成所需要的返回值，并且编辑某个返回值时，编辑所需字段可为多张表的多个字段，按照所编辑的规则处理成所需返回值，

正在编辑的接口可设置为不可被其他组员编辑，

组员利用接口管理模块根据上述一系列接口生成相关的规则完成接口的生成。

在上述后台接口管理系统中，还可包括测试模块，用于测试生成的接口是否正确，测试模块可通过类似postman的工具对生成的接口进行测试。

本系统将接口的处理规则在更底层实现，接口的编写变得极为简单，使接口编写不再成为后台开发人员工作，架构面向不同的用户，只要有权限，不同层次的人员均能够参与项目。

以上所述实施例仅是为充分说明本发明而所举的较佳的实施例，本发明的保护范围不限于此。本技术领域的技术人员在本发明基础上所作的等同替代或变换，均在本发明的保护范围之内。本发明的保护范围以权利要求书为准。

Claims (9)

1.一种后台接口管理系统，其特征是

基于yapi，还包括权限管理模块、项目管理模块、接口管理模块，

权限管理模块用于实现人员的权限控制，项目管理模块用于项目的配置及管理，接口管理模块用于项目的接口配置及管理，

权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。

2.根据权利要求1所述的系统，其特征是各级管理员分别是超级管理员、组长及组员，权限管理模块控制最高权限给超级管理员，超级管理员管理组长的权限，组长管理组员的权限。

3.根据权利要求2所述的系统，其特征是组长通过权限管理模块分配组员在项目中可处理的相应操作权限及对项目中的接口信息进行编辑的权限。

4.根据权利要求3所述的系统，其特征是组员获得权限管理模块相应的权限，对项目的相应操作包括insert操作、drop操作、select操作中的一种或几种。

5.根据权利要求3或4所述的系统，其特征是组员通过接口管理模块对项目中的接口信息，在项目前期编写接口地址，参数，返回值，mock数据供开发者使用，在项目后期编写与接口生成相关的规则，接口管理模块根据接口生成相关的规则生成接口。

6.根据权利要求5所述的系统，其特征是组员通过接口管理模块编辑的接口生成相关的规则包括接口参数规则、数据选取规则及返回值规则。

7.根据权利要求1-4或6任一所述的系统，其特征是还包括测试模块，用于测试生成的接口是否正确。

8.根据权利要求7任一所述的系统，其特征是测试模块利用postman工具对生成的接口进行测试。

9.一种后台接口管理系统的使用方法，其特征是利用权利要求1-8任一所述的系统，

使用权限管理模块实现人员的权限控制，使用项目管理模块进行项目的配置及管理，使用接口管理模块进行项目的接口配置及管理，

其中利用权限管理模块控制权限分配给各级管理员，各级管理员根据各自权限利用项目管理模块对项目进行配置及管理，各级管理员根据各自权限根据项目的配置及管理状态，对项目的相关接口利用接口管理模块进行项目的接口配置及管理。