RestCloud API接口管理平台

时间:2024-03-23 08:42:03

RestCloud API接口管理平台

  RestCloud API管理平台是完全自主研发的企业级统一API接口管理平台,本平台不但可以从Java代码中的注解自动扫描生成API文档还能通过OpenAPI3.0标准文档、手工等方式导入企业的其他API接口,最终形成企业的统一的API清单。 本平台功能全面优于swagger ui等开源的API接口生成平台,支持对API接口的搜索、分类、测试、导入OpenAPI3.0文档、导出OpenAPI3.0文档,导出Word文档、标签化管理、自动生成前端JSON常量等等功能。

RestCloud API接口管理平台

  •  
  • (通过API接口管理平台统一管理企业的所有API接口并进行分类和打标签,实现API接口的知识管理功能)

 

API接口管理平台-适用业务场景

  1. 企业的统一API接口管理平台
  2. 在SpringBoot中替代swagger ui开源组件
  3. 作为企业的API设计和数据模拟平台
  4. 作为企业的API统一文档入口管理平台
  5. 作为企业API的知识管理平台

RestCloud API接口管理平台主要功能

基于应用管理API接口

RestCloud可以从多工程,多应用、多分类、多标签、Class类等多维度来管理API接口,优于swagger ui的仅从Class类或分类来管理接口,当接口数量众多时RestCloud API接口管理平台将体现出极大优势

RestCloud API接口管理平台

API接口全局搜索

RestCloud API接口管理平台支持全局的模糊搜索和精确搜索,通过搜索可以快速定位一个API的来源和详细调用信息,而swagger ui开源组件是基于HashMap的内存对像很难进行搜索和分页查看,API文档一多将很难查找到所需接口。 
RestCloud API接口管理平台

Java注解自动扫描生成API文档

  基于RestCloud的注解规范对API进行注解,系统根据注解自动扫描生成API的详细文档,支持非常丰富的API注解说明. 
RestCloud API接口管理平台
(在Eclipse下对方法或类进行注解即可自动生成API文档,同时兼容SpringBoot的注解)

支持API按业务领域进行分类管理

每个API都可以指定一个或多个所属的分类,在API接口管理平台中将在多个分类中列出此API. 
RestCloud API接口管理平台
(按分类对API进行管理和查看)

API按标签聚合进行管理

RestCloud允许一个API打上多个标签,通过标签可以对API进行更多维度的管理和查找.

RestCloud API接口管理平台
(按标签进行API的聚合)

详细的API文档说明

RestCloud可以为API生成非常详细且个性化的API说明文档,远远超过swagger ui等开源组件的定义范围。

RestCloud API接口管理平台
RestCloud API接口管理平台
RestCloud API接口管理平台

OpenAPI3.0国际标准文档生成

RestCloud平台中的所有API文档都可以输出成为国际标准的OpenAPI3.0标准文档并且支持JSON和YAML格式,并且支持按Class类、按应用整体输出. 
RestCloud API接口管理平台
(平台中的任何API都可以直接输出成为OpenAPI3.0标准文档) 

RestCloud API接口管理平台
(平台中的API输出到SwaggerUI后的兼容效果图)

OpenAPI3.0国际标准文档导入

RestCloud平台中的API支持第三方设计的OpenAPI文档直接导入到RestCloud平台中并自动生成API文档和注解,支持JSON和YAML两种格式的文档自动导入,通过导入和导出功能RestCloud可以与第三方API平台形成完整的API设计链. 
RestCloud API接口管理平台
(任何第三方设计的标准OpenAPI文档都可以直接入到RestCloud平台生成API和代码)

API在线设计功能

RestCloud API接口管理平台允许用户根据业务需求直接通过Web界面对API进行设计无需编程人员参与就可以进行设计包括:url格式、输入参数、输出参数、较验规则、错误提示等等信息,一旦接口设计好后端开发人员可以根据自动生成的注解代码实现业务逻辑即可。 
RestCloud API接口管理平台
(可直接新增一个Rest API) 

RestCloud API接口管理平台
(可以针对新增的API设置输入参数、输出参数、验证规则等) 

RestCloud API接口管理平台
(根据设计好的API自动生成Java注解及方法代码)

API在线测试功能

RestCloud平台中所有API都可以直接点击测试按扭进行测试,无需借助任何第三方API测试工具,并且可以摸拟不同的用户帐号进行测试,不用来回切换帐号登录和退出操作,大大的加快了测试速度,测试参数可以直接保存为测试用例,下次测试时可以直接调出测试用例数据. 
RestCloud API接口管理平台
RestCloud API接口管理平台