CN111880950A - 基于政务云平台管理云服务api的方法及*** - Google Patents
基于政务云平台管理云服务api的方法及*** Download PDFInfo
- Publication number
- CN111880950A CN111880950A CN202010747981.1A CN202010747981A CN111880950A CN 111880950 A CN111880950 A CN 111880950A CN 202010747981 A CN202010747981 A CN 202010747981A CN 111880950 A CN111880950 A CN 111880950A
- Authority
- CN
- China
- Prior art keywords
- api
- project
- interface
- test
- data
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Granted
Links
- 238000007726 management method Methods 0.000 title description 52
- 238000012360 testing method Methods 0.000 claims abstract description 93
- 238000000034 method Methods 0.000 claims abstract description 47
- 230000008569 process Effects 0.000 claims abstract description 15
- 238000010276 construction Methods 0.000 claims abstract description 10
- 238000012163 sequencing technique Methods 0.000 claims abstract description 7
- 239000008186 active pharmaceutical agent Substances 0.000 claims description 237
- 238000012795 verification Methods 0.000 claims description 39
- 230000006870 function Effects 0.000 claims description 33
- 230000004044 response Effects 0.000 claims description 32
- 238000012423 maintenance Methods 0.000 claims description 6
- 238000012986 modification Methods 0.000 claims description 4
- 230000004048 modification Effects 0.000 claims description 4
- 238000012937 correction Methods 0.000 claims description 3
- 230000008676 import Effects 0.000 claims description 3
- 230000009191 jumping Effects 0.000 claims description 3
- 239000002699 waste material Substances 0.000 claims description 3
- 238000004891 communication Methods 0.000 description 3
- 230000005540 biological transmission Effects 0.000 description 2
- 238000010586 diagram Methods 0.000 description 2
- 238000013475 authorization Methods 0.000 description 1
- 238000005336 cracking Methods 0.000 description 1
- 238000011161 development Methods 0.000 description 1
- 230000007613 environmental effect Effects 0.000 description 1
- 238000002955 isolation Methods 0.000 description 1
- 210000001503 joint Anatomy 0.000 description 1
- 239000000463 material Substances 0.000 description 1
- 230000003287 optical effect Effects 0.000 description 1
- 238000006467 substitution reaction Methods 0.000 description 1
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
- G06F9/46—Multiprogramming arrangements
- G06F9/54—Interprogram communication
- G06F9/543—User-generated data transfer, e.g. clipboards, dynamic data exchange [DDE], object linking and embedding [OLE]
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
- G06F11/3684—Test management for test design, e.g. generating new test cases
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
- G06F11/3688—Test management for test execution, e.g. scheduling of test suites
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/30—Authentication, i.e. establishing the identity or authorisation of security principals
- G06F21/31—User authentication
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
- G06F9/46—Multiprogramming arrangements
- G06F9/54—Interprogram communication
- G06F9/546—Message passing systems or structures, e.g. queues
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Software Systems (AREA)
- Physics & Mathematics (AREA)
- General Engineering & Computer Science (AREA)
- General Physics & Mathematics (AREA)
- Computer Hardware Design (AREA)
- Computer Security & Cryptography (AREA)
- Quality & Reliability (AREA)
- Management, Administration, Business Operations System, And Electronic Commerce (AREA)
- Debugging And Monitoring (AREA)
Abstract
本发明公开了一种基于政务云平台管理云服务API的方法及***,属于政务云领域,本发明要解决的技术问题为如何对云服务API进行统一管理,实现API的业务化、项目管理以及测试用例的自动化构建,同时降低API测试及管理过程对操作人员的水平要求,采用的技术方案为:该方法具体如下:以项目为单位管理云服务API并能修改项目信息和删除项目;根据项目信息建立项目对应的API,对项目对应的API进行分组管理,并对分组进行排序;对单个API进行管理,完善项目对应API的预设信息;为API新增Mock数据。该***包括登录模块、权限控制模块、业务线模块、项目管理模块、API管理模块、API测试模块和API测试记录模块。
Description
技术领域
本发明涉及政务云领域,具体地说是一种基于政务云平台管理云服务API的方法及***。
背景技术
应用程序接口API:Application Program Interface),应用程序接口是一组定义、程序及协议的集合,通过API接口实现计算机软件之间的相互通信。API的一个主要功能是提供通用功能集。程序员通过调用API函数对应用程序进行开发,可以减轻编程任务。API同时也是一种中间件,为各种不同平台提供数据共享。根据单个或分布式平台上不同软件应用程序间的数据共享性能,可以将API分为四种类型:
①远程过程调用(RPC):通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信;
②标准查询语言(SQL):是标准的访问数据的查询语言,通过数据库实现应用程序间的数据共享;
③文件传输:文件传输通过发送格式化文件实现应用程序间数据共享;
④信息交付:指松耦合或紧耦合应用程序间的小型格式化信息,通过程序间的直接通信实现数据共享。
目前,政府大力提倡“一网通办”、“只跑一次”,提倡各单位各部门迁移上云,数据互通。对于政务云平台上的云服务API还没有一个统一的管理,各项目都是各自为战,数据无法互通,无法提供API文档供其他项目调用,在接口对接时,安全问题也很突出。随着云服务越来越普及,有越来越多的云服务会把自己的API开放出来供其他项目、其他单位使用。
现有的技术中,对于API的管理和测试还停留在手工阶段,当然也还有一些API测试工具,如Postman等,但是此类工具无法实现API的业务化、项目化管理,无法实现测试用例的自动化构建。测试和管理API的水平依托于操作人员的水平,且主观性较强,无法对云服务的API进行统一的管理。故如何对云服务API进行统一管理,实现API的业务化、项目管理以及测试用例的自动化构建,同时降低API测试及管理过程对操作人员的水平要求是亟待解决的技术问题。
发明内容
本发明的技术任务是提供一种基于政务云平台管理云服务API的方法及***,来解决如何对云服务API进行统一管理,实现API的业务化、项目管理以及测试用例的自动化构建,同时降低API测试及管理过程对操作人员的水平要求的问题。
本发明的技术任务是按以下方式实现的,一种基于政务云平台管理云服务API的方法,该方法具体如下:
以项目为单位管理云服务API并能修改项目信息和删除项目;
根据项目信息建立项目对应的API,对项目对应的API进行分组管理,并对分组进行排序;
对单个API进行管理,完善项目对应API的预设信息;
为API新增Mock数据;
在API详情功能中进行接口测试,先自动初始化接口URL和测试参数的信息,接口测试功能支持选择运行环境,再自动生成不同环境的完整URL链接,填写测试的参数值,即可发起一次接口请求,并显示出结果;显示结果即为接口响应数据,接口响应数据支持绑定数据结构,数据结构属性支持嵌套引用,也支持被复用;
进行接口测试后,保存本次测试结果(接口URL和测试参数的信息),并能够查看、还原和删除所有接口的测试历史记录;
以业务线为维度进行权限控制,拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
作为优选,所述项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
所述API的预设信息包括为API设置分组、标记API的星级、新增API、删除API、修改API、查询API、API属性完善及API备注信息支持Markdown。
更优地,所述Mock数据包括响应结果类型和响应结果数据;其中,响应结果类型包括Json、XML、HTML、TEXT及JSONP;响应结果数据是指每一条Mock数据生成一个唯一的Mock链接,访问该链接将会按照设置的数据类型如JSON返回对应格式的Mock数据。
一种基于政务云平台管理云服务API的***,该***包括,
登录模块,用于用户根据账号和密码登录API管理***,用户打开登录界面,输入用户名、密码和验证码完成登录;
权限控制模块,用于根据用户所拥有的业务线来判断用户所拥有的功能权限和数据权限,API管理***根据功能权限列出用户菜单,根据数据权限显示出符合用户的数据;
业务线模块,用于实现管理员对业务线进行维护,即对业务线进行增、删、改扣查的操作,并为业务线分配用户;
项目管理模块,用于新建或编辑API项目,即对项目进行增、删、改及查的操作;同时设置项目的三种环境,具体为测试环境、预发布环境及正式环境;
API管理模块,用于新建或编辑API,并完善API的预设信息,同时对API进行增、删、改及查的操作以及对API进行分组,确保同一性质的API统一管理和测试;其中,API属于项目,一个API仅属于一个项目,一个项目包括多个API;
API测试模块,用于选择构建方式,输入API参数并初始化API参数;
API测试记录模块,用于单条执行或批量执行,将API的测试用例的执行结果保存到测试结果库中,以便于后续分析。
作为优选,所述登录模块和权限控制模块的工作过程具体如下:
(一)、用户输入账号、密码和验证码;
(二)、判断账号是否存在:
①、若不存在,则提示账号错误,跳转至步骤(一),重新输入账号、密码和验证码;
②、若存在,则下一步执行步骤(三);
(三)、继续对密码进行判断,判断密码是否符合规范:
①、若不符合规范,则提示密码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(四);
(四)、对验证码进行不区分大小写和空格处理,判断验证码是否符合规范:
①、若不符合规范,则提示验证码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(五);
(五)、把账号、密码和验证码加密后传输到后台服务进行验证,后台首先验证验证码是否正确:
①、若不正确,则向前端返回验证码不正确,跳转至步骤(一),重新输入验证码;
②、若正确,则下一步执行步骤(六);
(六)、继续判断账号和密码,后台服务查找数据库,判断账号和密码是否匹配:
①、若不匹配,则向前端返回账号和密码错误,跳转至步骤(一),重新输入并提交;
②、若匹配,则该用户登录成功,下一步执行步骤(七);
(七)、API管理***读取该用户的角色,获取该用户的功能权限和数据权限,下一步执行步骤(八);
(八)、根据功能权限列出用户菜单,下一步执行步骤(九);
(九)、根据数据权限显示出符合该用户的数据。
作为优选,所述项目管理模块和API管理模块的工作过程具体如下:
(1)、准备项目信息:项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
(2)、创建项目:根据准备好的项目信息创建项目,支持更新和删除项目;
(3)、创建API分组:支持API分组排序以及更新和删除分组;
(4)、准备API信息,即准备API的预设信息,API的预设信息包括基础信息、请求头部、请求参数、响应结果和API描述;其中,基础信息包括URL、分组、Method、状态和名称;URL为接口请求的地址,注意此处为相对地址,根地址从所属项目的根地址属性上获取;Method为请求方法,如get、post等等;状态为接口状态,在接口列表中,启用状态接口用绿色圆圈标识,维护状态接口用黄色圆圈标识,废弃状态接口用灰色圆圈标识;
请求头部包括头部标签和头部内容;头部标签是指请求头部的类型,如Accept-Encoding;头部内容是指请求头部的值,如Accept-Encoding头部标签对应的值UTF-8;
请求参数是指同一接口支持设置多个请求参数,请求参数包括参数名称、说明、类型以及是否必填;
响应结果包括响应数据类型MIME和为响应数据绑定数据结构;响应数据类型设置为Json或者XML;
API描述是指支持Markdown格式的属性描述;
(5)、使用Markdown完善接口描述;
(6)、创建API,并支持更新和删除API;
(7)、API分组:标记API的星级;
(8)、搜索API:支持API搜索,搜索关键字为URL;
(9)、导出导入API:API接口列表导出为PDF格式的接口文档,支持Swagger及Postman的格式接口数据的导入。
更优地,所述API测试模块和API测试记录模块的工作过程具体如下:
①、进入接口详情功能,准备Mock数据,Mock数据包括结果数据类型和结果数据;
②、为接口新增Mock数据,并支持更新和删除Mock数据;
③、设置接口测试所需要的请求头部和请求参数;
④、进行单个接口测试及分组批量接口测试;
⑤、测试记录保存。
作为优选,该***还包括,
用户管理模块,用于提供管理员和普通用户两种用户角色,不同角色用户均能够通过修改密码功能修改个人登录密码;管理员拥有***所有权限;普通用户默认仅拥有项目接口和数据类型的只读权限,被分配业务线权限后,才允许操作业务线下项目和接口;管理员角色用于管理***用户信息,如添加用户、设置用户角色,分配权限等;
业务线管理模块,用于提供分类管理和权限控制功能;分类管理是项目接口归属于业务线下,通过业务线隔离不同的项目接口,方便管理;权限控制是API管理***以业务线为维度进行权限控制,用户只有拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
一种电子设备,包括:存储器和至少一个处理器;
其中,所述存储器存储计算机执行指令;
所述至少一个处理器执行所述存储器存储的计算机执行指令,使得所述至少一个处理器执行如上述的基于政务云平台管理云服务API的方法。
一种计算机可读存储介质,所述计算机可读存储介质中存储有计算机执行指令,当处理器执行所述计算机执行时,实现如上述的基于政务云平台管理云服务API的方法。
本发明的基于政务云平台管理云服务API的方法及***具有以下优点:
(一)政务云属于行业云,是面向政府行业,政务云中的云服务规模大、数量多,云服务的API需要统一管理,本发明具有API隔离、单个项目的API分组、标记星级、单个API管理、丰富的API属性完善、备注信息支持Markdown、支持Mock、在线测试、权限控制的功能,实现了API的业务化、项目管理以及测试用例的自动化构建,同时降低API测试及管理过程对操作人员的水平要求;
(二)本发明对API的管理和测试进行严格的权限控制,做到了功能安全和数据安全;构建方式包括测试环境、预发布环境、正式环境三种方式;对API进行分组和星级标记,方便API的直观管理;API的描述支持Markdown格式;对返回结果的类型和数据支持Mock;可以保存API测试记录,使得后续相同的API测试无需再查找API参数和重新分析返回结果;
(三)本发明对用户登录进行密码和验证码双因子认证,保证安全;对账号、密码和验证码进行前端和后端双验证,保证无法暴力破解;登陆Token与用户密码均进行md5加密,提升***安全性;用户拥有功能权限和数据权限,不仅能保证功能安全,更能保证数据安全;
(四)本发明的项目管理包括全部的三种环境,有效解决API在不同环境下的管理和测试难题;对API进行分组并且标记星级,有效解决大量API的管理问题;单个API包含详细和完善的基础信息,能有效快速测试API;使用Markdown完善接口描述,浏览器能够识别Markdown格式,能优化接口描述的展现形式;***支持录入数据类型,数据类型支持嵌套,每个API只需要绑定一个数据类型,不需要单独执行响应数据参数;搜索关键字为URL,更加贴合用户需求;
(五)本发明的Mock数据有效解决接口未开发完毕或者未部署时,其他服务无法调用的问题,从而快速提供Mock接口,加快开发进度;单个接口测试,能有效解决开发人员快速调用和调试单个接口;分组批量接口测试能实现接口的规模化测试,一键完成所有的接口测试,规模化、自动化,提高测试效率,节省人力、物力和财力;
(六)本发明针对项目以业务线为粒度进行分类管理,有效解决同一业务线上不同项目接口难以管理的问题;通过业务线分配接口权限,有效解决功能安全和数据安全问题。
附图说明
下面结合附图对本发明进一步说明。
附图1为基于政务云平台管理云服务API的***结构框图;
附图2为基于政务云平台管理云服务API的***的工作过程的流程框图;
附图3为登录模块和权限控制模块的工作过程的流程框图;
附图4为项目管理模块和API管理模块的工作过程的流程框图;
附图5为API测试模块和API测试记录模块的工作过程的流程框图。
具体实施方式
参照说明书附图和具体实施例对本发明的基于政务云平台管理云服务API的方法及***作以下详细地说明。
实施例1:
本发明的基于政务云平台管理云服务API的方法,该方法具体如下:
S1、以项目为单位管理云服务API并能修改项目信息和删除项目;项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
S2、根据项目信息建立项目对应的API,对项目对应的API进行分组管理,并对分组进行排序;
S3、对单个API进行管理,完善项目对应API的预设信息;API的预设信息包括为API设置分组、标记API的星级、新增API、删除API、修改API、查询API、API属性完善及API备注信息支持Markdown。
S4、为API新增Mock数据;Mock数据包括响应结果类型和响应结果数据;其中,响应结果类型包括Json、XML、HTML、TEXT及JSONP;响应结果数据是指每一条Mock数据生成一个唯一的Mock链接,访问该链接将会按照设置的数据类型如JSON返回对应格式的Mock数据。
S5、在API详情功能中进行接口测试,先自动初始化接口URL和测试参数的信息,接口测试功能支持选择运行环境,再自动生成不同环境的完整URL链接,填写测试的参数值,即可发起一次接口请求,并显示出结果;显示结果即为接口响应数据,接口响应数据支持绑定数据结构,数据结构属性支持嵌套引用,也支持被复用;
S6、进行接口测试后,保存本次测试结果(接口URL和测试参数的信息),并能够查看、还原和删除所有接口的测试历史记录;
S7、以业务线为维度进行权限控制,拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
实施例2:
如附图1所示,本发明的基于政务云平台管理云服务API的***,该***包括,
登录模块,用于用户根据账号和密码登录API管理***,用户打开登录界面,输入用户名、密码和验证码完成登录;
权限控制模块,用于根据用户所拥有的业务线来判断用户所拥有的功能权限和数据权限,API管理***根据功能权限列出用户菜单,根据数据权限显示出符合用户的数据;
业务线模块,用于实现管理员对业务线进行维护,即对业务线进行增、删、改扣查的操作,并为业务线分配用户;
项目管理模块,用于新建或编辑API项目,即对项目进行增、删、改及查的操作;同时设置项目的三种环境,具体为测试环境、预发布环境及正式环境;
API管理模块,用于新建或编辑API,并完善API的预设信息,同时对API进行增、删、改及查的操作以及对API进行分组,确保同一性质的API统一管理和测试;其中,API属于项目,一个API仅属于一个项目,一个项目包括多个API;
API测试模块,用于选择构建方式,输入API参数并初始化API参数;
API测试记录模块,用于单条执行或批量执行,将API的测试用例的执行结果保存到测试结果库中,以便于后续分析;
用户管理模块,用于提供管理员和普通用户两种用户角色,不同角色用户均能够通过修改密码功能修改个人登录密码;管理员拥有***所有权限;普通用户默认仅拥有项目接口和数据类型的只读权限,被分配业务线权限后,才允许操作业务线下项目和接口;管理员角色用于管理***用户信息,如添加用户、设置用户角色,分配权限等;
业务线管理模块,用于提供分类管理和权限控制功能;分类管理是项目接口归属于业务线下,通过业务线隔离不同的项目接口,方便管理;权限控制是API管理***以业务线为维度进行权限控制,用户只有拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
该***的部署方式具体如下:
1)、环境要求:Maven 3+、JDK 1.8+、Mysql 5.7+;
2)、数据库准备,初始化Sql脚本,执行hc-api-mysql.sql文件;
3)、配置JDBC链接,配置文件的名称为:hc-api.properties、
4)、源码编译:mvn clean install、
5)、云主机部署时,用java命令运行生成的jar包:java–jar hc-api-admin.jar、
6)、集群部署时,每个jar包的JDBC链接设置成一致即可、
7)、容器部署时,先推送jar包镜像到docker,然后利用docker命令运行该镜像:docker run hc-api-admin。
如附图2所示,该***的工作过程如下:
(Ⅰ)、登录:用户根据账号和密码登录API管理***;
(Ⅱ)、权限控制:API管理***根据该用户所拥有的业务线进行权限控制,包括功能权限和数据权限;
(Ⅲ)、创建项目;
(Ⅳ)、创建项目API:完善该项目API的预设信息,包括为API设置分组、标记API的星级及API属性完善;
(Ⅴ)、初始化API参数:选择构建方式,输入API参数;
(Ⅵ)、Mock返回结果;
(Ⅶ)、执行API测试:包括单条和批量执行,并自动保存测试记录。
如附图3所示,登录模块和权限控制模块的工作过程具体如下:
(一)、用户输入账号、密码和验证码;
(二)、判断账号是否存在:
①、若不存在,则提示账号错误,跳转至步骤(一),重新输入账号、密码和验证码;
②、若存在,则下一步执行步骤(三);
(三)、继续对密码进行判断,判断密码是否符合规范:
①、若不符合规范,则提示密码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(四);
(四)、对验证码进行不区分大小写和空格处理,判断验证码是否符合规范:
①、若不符合规范,则提示验证码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(五);
(五)、把账号、密码和验证码加密后传输到后台服务进行验证,后台首先验证验证码是否正确:
①、若不正确,则向前端返回验证码不正确,跳转至步骤(一),重新输入验证码;
②、若正确,则下一步执行步骤(六);
(六)、继续判断账号和密码,后台服务查找数据库,判断账号和密码是否匹配:
①、若不匹配,则向前端返回账号和密码错误,跳转至步骤(一),重新输入并提交;
②、若匹配,则该用户登录成功,下一步执行步骤(七);
(七)、API管理***读取该用户的角色,获取该用户的功能权限和数据权限,下一步执行步骤(八);
(八)、根据功能权限列出用户菜单,下一步执行步骤(九);
(九)、根据数据权限显示出符合该用户的数据。
如附图4所示,项目管理模块和API管理模块的工作过程具体如下:
(1)、准备项目信息:项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
(2)、创建项目:根据准备好的项目信息创建项目,支持更新和删除项目;
(3)、创建API分组:支持API分组排序以及更新和删除分组;
(4)、准备API信息,即准备API的预设信息,API的预设信息包括基础信息、请求头部、请求参数、响应结果和API描述;其中,基础信息包括URL、分组、Method、状态和名称;URL为接口请求的地址,注意此处为相对地址,根地址从所属项目的根地址属性上获取;Method为请求方法,如get、post等等;状态为接口状态,在接口列表中,启用状态接口用绿色圆圈标识,维护状态接口用黄色圆圈标识,废弃状态接口用灰色圆圈标识;
请求头部包括头部标签和头部内容;头部标签是指请求头部的类型,如Accept-Encoding;头部内容是指请求头部的值,如Accept-Encoding头部标签对应的值UTF-8;
请求参数是指同一接口支持设置多个请求参数,请求参数包括参数名称、说明、类型以及是否必填;
响应结果包括响应数据类型MIME和为响应数据绑定数据结构;响应数据类型设置为Json或者XML;
API描述是指支持Markdown格式的属性描述;
(5)、使用Markdown完善接口描述;
(6)、创建API,并支持更新和删除API;
(7)、API分组:标记API的星级;
(8)、搜索API:支持API搜索,搜索关键字为URL;
(9)、导出导入API:API接口列表导出为PDF格式的接口文档,支持Swagger及Postman的格式接口数据的导入。
如附图5所示,API测试模块和API测试记录模块的工作过程具体如下:
①、进入接口详情功能,准备Mock数据,Mock数据包括结果数据类型和结果数据;
②、为接口新增Mock数据,并支持更新和删除Mock数据;
③、设置接口测试所需要的请求头部和请求参数;
④、进行单个接口测试及分组批量接口测试;
⑤、测试记录保存。
实施例3:
本发明实施例还提供了一种电子设备,包括:存储器和一个处理器;
其中,存储器存储计算机执行指令;
一个处理器执行所述存储器存储的计算机执行指令,使得所述一个处理器执行如实施例1中的基于政务云平台管理云服务API的方法。
实施例4:
本发明实施例还提供了一种计算机可读存储介质,其中存储有多条指令,指令由处理器加载,使处理器执行本发明任一实施例中的基于政务云平台管理云服务API的方法。具体地,可以提供配有存储介质的***或者装置,在该存储介质上存储着实现上述实施例中任一实施例的功能的软件程序代码,且使该***或者装置的计算机(或CPU或MPU)读出并执行存储在存储介质中的程序代码。
在这种情况下,从存储介质读取的程序代码本身可实现上述实施例中任何一项实施例的功能,因此程序代码和存储程序代码的存储介质构成了本发明的一部分。
用于提供程序代码的存储介质实施例包括软盘、硬盘、磁光盘、光盘(如CD-ROM、CD-R、CD-RW、DVD-ROM、DVD-R基于政务云平台管理云服务API的方法及***M、DVD-RW、DVD+RW)、磁带、非易失性存储卡和ROM。可选择地,可以由通信网络从服务器计算机上下载程序代码。
此外,应该清楚的是,不仅可以通过执行计算机所读出的程序代码,而且可以通过基于程序代码的指令使计算机上操作的操作***等来完成部分或者全部的实际操作,从而实现上述实施例中任意一项实施例的功能。
此外,可以理解的是,将由存储介质读出的程序代码写到***计算机内的扩展板中所设置的存储器中或者写到与计算机相连接的扩展单元中设置的存储器中,随后基于程序代码的指令使安装在扩展板或者扩展单元上的CPU等来执行部分和全部实际操作,从而实现上述实施例中任一实施例的功能。
最后应说明的是:以上各实施例仅用以说明本发明的技术方案,而非对其限制;尽管参照前述各实施例对本发明进行了详细的说明,本领域的普通技术人员应当理解:其依然可以对前述各实施例所记载的技术方案进行修改,或者对其中部分或者全部技术特征进行等同替换;而这些修改或者替换,并不使相应技术方案的本质脱离本发明各实施例技术方案的范围。
Claims (10)
1.一种基于政务云平台管理云服务API的方法,其特征在于,该方法具体如下:
以项目为单位管理云服务API并能修改项目信息和删除项目;
根据项目信息建立项目对应的API,对项目对应的API进行分组管理,并对分组进行排序;
对单个API进行管理,完善项目对应API的预设信息;
为API新增Mock数据;
在API详情功能中进行接口测试,先自动初始化接口URL和测试参数的信息,再自动生成不同环境的完整URL链接,填写测试的参数值,即可发起一次接口请求,并显示出结果;
进行接口测试后,保存本次测试结果,并能够查看、还原和删除所有接口的测试历史记录;
以业务线为维度进行权限控制,拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
2.根据权利要求1所述的基于政务云平台管理云服务API的方法,其特征在于,所述项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
所述API的预设信息包括为API设置分组、标记API的星级、新增API、删除API、修改API、查询API、API属性完善及API备注信息支持Markdown。
3.根据权利要求1或2所述的基于政务云平台管理云服务API的方法,其特征在于,所述Mock数据包括响应结果类型和响应结果数据;其中,响应结果类型包括Json、XML、HTML、TEXT及JSONP;响应结果数据是指每一条Mock数据生成一个唯一的Mock链接,访问该链接将会按照设置的数据类型如JSON返回对应格式的Mock数据。
4.一种基于政务云平台管理云服务API的***,其特征在于,该***包括,
登录模块,用于用户根据账号和密码登录API管理***,用户打开登录界面,输入用户名、密码和验证码完成登录;
权限控制模块,用于根据用户所拥有的业务线来判断用户所拥有的功能权限和数据权限,API管理***根据功能权限列出用户菜单,根据数据权限显示出符合用户的数据;
业务线模块,用于实现管理员对业务线进行维护,即对业务线进行增、删、改扣查的操作,并为业务线分配用户;
项目管理模块,用于新建或编辑API项目,即对项目进行增、删、改及查的操作;同时设置项目的三种环境,具体为测试环境、预发布环境及正式环境;
API管理模块,用于新建或编辑API,并完善API的预设信息,同时对API进行增、删、改及查的操作以及对API进行分组,确保同一性质的API统一管理和测试;其中,API属于项目,一个API仅属于一个项目,一个项目包括多个API;
API测试模块,用于选择构建方式,输入API参数并初始化API参数;
API测试记录模块,用于单条执行或批量执行,将API的测试用例的执行结果保存到测试结果库中,以便于后续分析。
5.根据权利要求4所述的基于政务云平台管理云服务API的***,其特征在于,所述登录模块和权限控制模块的工作过程具体如下:
(一)、用户输入账号、密码和验证码;
(二)、判断账号是否存在:
①、若不存在,则提示账号错误,跳转至步骤(一),重新输入账号、密码和验证码;
②、若存在,则下一步执行步骤(三);
(三)、继续对密码进行判断,判断密码是否符合规范:
①、若不符合规范,则提示密码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(四);
(四)、对验证码进行不区分大小写和空格处理,判断验证码是否符合规范:
①、若不符合规范,则提示验证码不符合规范,跳转至步骤(一),重新输入;
②、若符合规范,则下一步执行步骤(五);
(五)、把账号、密码和验证码加密后传输到后台服务进行验证,后台首先验证验证码是否正确:
①、若不正确,则向前端返回验证码不正确,跳转至步骤(一),重新输入验证码;
②、若正确,则下一步执行步骤(六);
(六)、继续判断账号和密码,后台服务查找数据库,判断账号和密码是否匹配:
①、若不匹配,则向前端返回账号和密码错误,跳转至步骤(一),重新输入并提交;
②、若匹配,则该用户登录成功,下一步执行步骤(七);
(七)、API管理***读取该用户的角色,获取该用户的功能权限和数据权限,下一步执行步骤(八);
(八)、根据功能权限列出用户菜单,下一步执行步骤(九);
(九)、根据数据权限显示出符合该用户的数据。
6.根据权利要求4所述的基于政务云平台管理云服务API的***,其特征在于,所述项目管理模块和API管理模块的工作过程具体如下:
(1)、准备项目信息:项目信息包括项目的属性信息和项目的跟地址,项目的属性信息包括业务线、项目名称及项目描述,项目的根地址包括测试地址、预发布地址及线上地址;
(2)、创建项目:根据准备好的项目信息创建项目,支持更新和删除项目;
(3)、创建API分组:支持API分组排序以及更新和删除分组;
(4)、准备API信息,即准备API的预设信息,API的预设信息包括基础信息、请求头部、请求参数、响应结果和API描述;其中,基础信息包括URL、分组、Method、状态和名称;URL为接口请求的地址,根地址从所属项目的根地址属性上获取;Method为请求方法;状态为接口状态,在接口列表中,启用状态接口用绿色圆圈标识,维护状态接口用黄色圆圈标识,废弃状态接口用灰色圆圈标识;
请求头部包括头部标签和头部内容;头部标签是指请求头部的类型;头部内容是指请求头部的值;
请求参数是指同一接口支持设置多个请求参数,请求参数包括参数名称、说明、类型以及是否必填;
响应结果包括响应数据类型MIME和为响应数据绑定数据结构;响应数据类型设置为Json或者XML;
API描述是指支持Markdown格式的属性描述;
(5)、使用Markdown完善接口描述;
(6)、创建API,并支持更新和删除API;
(7)、API分组:标记API的星级;
(8)、搜索API:支持API搜索,搜索关键字为URL;
(9)、导出导入API:API接口列表导出为PDF格式的接口文档,支持Swagger及Postman的格式接口数据的导入。
7.根据权利要求4-6中任一所述的基于政务云平台管理云服务API的***,其特征在于,所述API测试模块和API测试记录模块的工作过程具体如下:
①、进入接口详情功能,准备Mock数据,Mock数据包括结果数据类型和结果数据;
②、为接口新增Mock数据,并支持更新和删除Mock数据;
③、设置接口测试所需要的请求头部和请求参数;
④、进行单个接口测试及分组批量接口测试;
⑤、测试记录保存。
8.根据权利要求4所述的基于政务云平台管理云服务API的***,其特征在于,该***还包括,
用户管理模块,用于提供管理员和普通用户两种用户角色,不同角色用户均能够通过修改密码功能修改个人登录密码;管理员拥有***所有权限;普通用户默认仅拥有项目接口和数据类型的只读权限,被分配业务线权限后,才允许操作业务线下项目和接口;管理员角色用于管理***用户信息;
业务线管理模块,用于提供分类管理和权限控制功能;分类管理是项目接口归属于业务线下,通过业务线隔离不同的项目接口,方便管理;权限控制是API管理***以业务线为维度进行权限控制,用户只有拥有业务线权限,才允许操作业务线下项目接口,否则只允许查看。
9.一种电子设备,其特征在于,包括:存储器和至少一个处理器;
其中,所述存储器存储计算机执行指令;
所述至少一个处理器执行所述存储器存储的计算机执行指令,使得所述至少一个处理器执行如权利要求1至3任一项所述的基于政务云平台管理云服务API的方法。
10.一种计算机可读存储介质,其特征在于,所述计算机可读存储介质中存储有计算机执行指令,当处理器执行所述计算机执行时,实现如权利要求1至3中所述的基于政务云平台管理云服务API的方法。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202010747981.1A CN111880950B (zh) | 2020-07-30 | 2020-07-30 | 基于政务云平台管理云服务api的方法及*** |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202010747981.1A CN111880950B (zh) | 2020-07-30 | 2020-07-30 | 基于政务云平台管理云服务api的方法及*** |
Publications (2)
Publication Number | Publication Date |
---|---|
CN111880950A true CN111880950A (zh) | 2020-11-03 |
CN111880950B CN111880950B (zh) | 2023-12-26 |
Family
ID=73201995
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN202010747981.1A Active CN111880950B (zh) | 2020-07-30 | 2020-07-30 | 基于政务云平台管理云服务api的方法及*** |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN111880950B (zh) |
Cited By (16)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN112541031A (zh) * | 2020-12-21 | 2021-03-23 | 四川新网银行股份有限公司 | 一种基于自动化数据组装的统一数据服务方法和*** |
CN112685201A (zh) * | 2020-12-31 | 2021-04-20 | 中国建设银行股份有限公司 | 政务服务接入控制方法和装置 |
CN112764774A (zh) * | 2020-12-31 | 2021-05-07 | 炬星科技(深圳)有限公司 | 一种制品信息管理方法、管理***、电子设备及存储介质 |
CN112860551A (zh) * | 2021-02-02 | 2021-05-28 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
CN113098867A (zh) * | 2021-04-01 | 2021-07-09 | 刘宏达 | 基于人工智能的网络安全大数据处理方法及大数据云*** |
CN113159737A (zh) * | 2021-05-27 | 2021-07-23 | 中国平安人寿保险股份有限公司 | Rpa业务处理方法、rpa管理平台、设备及介质 |
CN113518008A (zh) * | 2021-07-07 | 2021-10-19 | 北京明略软件***有限公司 | 基于网关接入的服务的处理方法及装置 |
CN113535264A (zh) * | 2021-07-07 | 2021-10-22 | 北京明略软件***有限公司 | Api的处理方法及装置、电子设备 |
CN113592436A (zh) * | 2021-07-09 | 2021-11-02 | 上海云轴信息科技有限公司 | 一种基于政务云平台的云服务管理方法与设备 |
CN113778863A (zh) * | 2021-08-23 | 2021-12-10 | 行云智网络科技(北京)有限公司 | 一种自动化测试的方法及*** |
CN114117505A (zh) * | 2022-01-26 | 2022-03-01 | 湖南湘生网络信息有限公司 | 一种基于控制组的通用bs架构权限管理控制*** |
CN114996106A (zh) * | 2022-04-22 | 2022-09-02 | 马上消费金融股份有限公司 | 业务***的测试方法、电子设备和存储介质 |
CN115190016A (zh) * | 2022-07-25 | 2022-10-14 | 平安科技(深圳)有限公司 | ***通用开关配置方法、装置、设备及存储介质 |
CN116128517A (zh) * | 2023-02-17 | 2023-05-16 | 连云港海通市民一卡通有限公司 | 一种一卡通运营数据安全管理方法及*** |
CN116974624A (zh) * | 2023-06-28 | 2023-10-31 | 三峡科技有限责任公司 | 一种企业级接口文档管理的***和方法 |
CN117081849A (zh) * | 2023-09-28 | 2023-11-17 | 上海佑瞻智能科技有限公司 | 一种基于用户行为分析的异构云平台统一管理方法 |
Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US20120254431A1 (en) * | 2011-03-29 | 2012-10-04 | Sap Ag | Framework for Diversified Provisioning of Services into Business Networks |
CN106327310A (zh) * | 2016-09-13 | 2017-01-11 | 四川虹慧云商科技有限公司 | 一种基于云技术的智慧商业平台 |
-
2020
- 2020-07-30 CN CN202010747981.1A patent/CN111880950B/zh active Active
Patent Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US20120254431A1 (en) * | 2011-03-29 | 2012-10-04 | Sap Ag | Framework for Diversified Provisioning of Services into Business Networks |
CN106327310A (zh) * | 2016-09-13 | 2017-01-11 | 四川虹慧云商科技有限公司 | 一种基于云技术的智慧商业平台 |
Non-Patent Citations (1)
Title |
---|
易书林;刘毅;: "基于SSH框架的云计算建筑项目管理***研究", 现代电子技术, no. 19 * |
Cited By (24)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN112541031A (zh) * | 2020-12-21 | 2021-03-23 | 四川新网银行股份有限公司 | 一种基于自动化数据组装的统一数据服务方法和*** |
CN112685201A (zh) * | 2020-12-31 | 2021-04-20 | 中国建设银行股份有限公司 | 政务服务接入控制方法和装置 |
CN112764774A (zh) * | 2020-12-31 | 2021-05-07 | 炬星科技(深圳)有限公司 | 一种制品信息管理方法、管理***、电子设备及存储介质 |
CN112764774B (zh) * | 2020-12-31 | 2024-05-14 | 炬星科技(深圳)有限公司 | 一种制品信息管理方法、管理***、电子设备及存储介质 |
CN112860551A (zh) * | 2021-02-02 | 2021-05-28 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
CN112860551B (zh) * | 2021-02-02 | 2024-04-30 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
CN113098867B (zh) * | 2021-04-01 | 2021-12-14 | 博思盈(成都)建筑科技有限公司 | 基于人工智能的网络安全大数据处理方法及大数据云*** |
CN113098867A (zh) * | 2021-04-01 | 2021-07-09 | 刘宏达 | 基于人工智能的网络安全大数据处理方法及大数据云*** |
CN113159737A (zh) * | 2021-05-27 | 2021-07-23 | 中国平安人寿保险股份有限公司 | Rpa业务处理方法、rpa管理平台、设备及介质 |
CN113518008A (zh) * | 2021-07-07 | 2021-10-19 | 北京明略软件***有限公司 | 基于网关接入的服务的处理方法及装置 |
CN113535264A (zh) * | 2021-07-07 | 2021-10-22 | 北京明略软件***有限公司 | Api的处理方法及装置、电子设备 |
CN113592436A (zh) * | 2021-07-09 | 2021-11-02 | 上海云轴信息科技有限公司 | 一种基于政务云平台的云服务管理方法与设备 |
CN113592436B (zh) * | 2021-07-09 | 2024-02-06 | 上海云轴信息科技有限公司 | 一种基于政务云平台的云服务管理方法与设备 |
CN113778863A (zh) * | 2021-08-23 | 2021-12-10 | 行云智网络科技(北京)有限公司 | 一种自动化测试的方法及*** |
CN114117505A (zh) * | 2022-01-26 | 2022-03-01 | 湖南湘生网络信息有限公司 | 一种基于控制组的通用bs架构权限管理控制*** |
CN114996106A (zh) * | 2022-04-22 | 2022-09-02 | 马上消费金融股份有限公司 | 业务***的测试方法、电子设备和存储介质 |
CN115190016B (zh) * | 2022-07-25 | 2023-04-28 | 平安科技(深圳)有限公司 | ***通用开关配置方法、装置、设备及存储介质 |
CN115190016A (zh) * | 2022-07-25 | 2022-10-14 | 平安科技(深圳)有限公司 | ***通用开关配置方法、装置、设备及存储介质 |
CN116128517B (zh) * | 2023-02-17 | 2023-09-22 | 连云港海通市民一卡通有限公司 | 一种一卡通运营数据安全管理方法及*** |
CN116128517A (zh) * | 2023-02-17 | 2023-05-16 | 连云港海通市民一卡通有限公司 | 一种一卡通运营数据安全管理方法及*** |
CN116974624A (zh) * | 2023-06-28 | 2023-10-31 | 三峡科技有限责任公司 | 一种企业级接口文档管理的***和方法 |
CN116974624B (zh) * | 2023-06-28 | 2024-04-05 | 三峡科技有限责任公司 | 一种企业级接口文档管理的***和方法 |
CN117081849A (zh) * | 2023-09-28 | 2023-11-17 | 上海佑瞻智能科技有限公司 | 一种基于用户行为分析的异构云平台统一管理方法 |
CN117081849B (zh) * | 2023-09-28 | 2024-02-13 | 上海佑瞻智能科技有限公司 | 一种基于用户行为分析的异构云平台统一管理*** |
Also Published As
Publication number | Publication date |
---|---|
CN111880950B (zh) | 2023-12-26 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN111880950B (zh) | 基于政务云平台管理云服务api的方法及*** | |
US10579803B1 (en) | System and method for management of application vulnerabilities | |
US10795709B2 (en) | Systems and method for deploying, securing, and maintaining computer-based analytic environments | |
CN111930635B (zh) | 基于swagger快速自动化测试的方法及*** | |
Upton et al. | CodeIgniter for rapid php application development | |
CN102332072B (zh) | 用于检测恶意软件和管理恶意软件相关信息的***和方法 | |
US20130318152A1 (en) | Method and system for exchanging information between back-end and front-end systems | |
CN102254111A (zh) | 恶意网站检测方法及装置 | |
US20210103863A1 (en) | Cross-enterprise workflow adaptation | |
US8095573B2 (en) | Automatic reconciliation of discrepancies in asset attribute values | |
CN112581201A (zh) | 一种面向工业互联制造的移动开放平台及实现方法 | |
CN103281297A (zh) | 企业信息安全管理***与方法 | |
CN112765102B (zh) | 一种文件***管理方法和装置 | |
US10250586B2 (en) | Security certification and application categorization for mobile device management | |
CN116982029A (zh) | 对基于事件的应用进行托管 | |
Keating | Mastering Ansible | |
CN112015715A (zh) | 工业互联网数据管理服务测试方法及*** | |
CN113434217B (zh) | 漏洞扫描方法、装置、计算机设备及介质 | |
Davi | Design and development of an enterprise digital distribution platform for mobile applications | |
Andersson et al. | Microsoft Exchange Server 2016 PowerShell Cookbook | |
Ala-Ilomäki | Application programming interface management for cloud entities of an enterprise resource planning software | |
CN112783604B (zh) | 一种基于PaaS的应用调度和工作流编排方法及*** | |
US20230328049A1 (en) | Enterprise governance inventory and automation tool | |
Karvonen | Development of a communication tool | |
Shasankar | Zend framework 2.0 by example beginner's guide |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
PB01 | Publication | ||
PB01 | Publication | ||
SE01 | Entry into force of request for substantive examination | ||
SE01 | Entry into force of request for substantive examination | ||
GR01 | Patent grant | ||
GR01 | Patent grant |