[发明专利]一种中心化接口文档管理平台

说明书

本发明公开了一种中心化接口文档管理平台，主要关键点在于项目整体的技术架构采用服务端+客户端的模式。支持接口文档的实时分享及丰富的分享方式和时效性控制，支持自动化测试(采用客户端的模式打通内网测试)定义自己期望的正确数据生成测试报告使用多种通知方式通知用户，精细的权限控制、授权控制保证接口文档的安全性、丰富的钩子触发事件完成各种个性化需求。帮助企业管理项目接口文档，轻松与第三方对接。

技术领域

本发明涉及大数据、接口文档技术领域，更具体的说是涉及一种中心化接口文档管理平台。

背景技术

在前后端分离的情况下，前端和后端的唯一关联就是接口，那么描述这个接口的接口文档让调用者快速上手就显得相当重要，在和其他公司对接接口的时候也会用到，团队协作中更新了接口如何告知使用这个接口的人？各个项目中的接口文档、不同版本的接口文档、给不同人员的接口文档等等，这些情况如果接口文档直接存在电脑中去区分管理那么是十分困难的，所以我们迫切的希望有接口文档管理平台帮我们统一管理这些接口文档。在现有的接口文档管理平台中，在接口测试、接口分享等方面还有所欠缺，产业链发展并不成熟，不能形成一个完整的接口管理平台生态圈。

因此，如何提供一种易于使用、生态完整的中心化接口文档管理平台是本领域技术人员亟需解决的问题。

发明内容

有鉴于此，本发明提供了一种中心化接口文档管理平台将在现有的先进技术基础上，针对现有技术的缺点，提出有效的解决方法并实行，将中心化接口文档管理应用技术覆盖率扩大，让更多的企业可应用中心化接口文档管理技术，让对接更容易，让使用更简单，更加规范化，保证接口文档的安全的同时保证便捷的分享接口文档，形成一个较为完善的接口文档管理生态圈。

为了实现上述目的，本发明提供如下技术方案：

一种中心化接口文档管理平台，包括：项目管理模块、社交管理模块、接口管理模块、分享管理模块、通知管理模块、客户端管理模块、个人中心模块，以及客户端接口管理模块、接口测试模块、授权管理模块；

其中，所述接口管理模块分别与所述项目管理模块和社交管理连接，将接口管理过程中产生的接口数据交给项目管理模块进行划分、权限的分配给社交管理模块下的用户；

所述项目管理模块与所述分享管理模块连接，将项目管理下的接口在固定的时间内按项目或类别或具体接口根据不同的分享格式分享给他人；

所述通知管理模块将系统中触发的各种事件通知给需要的用户；

所述个人中心模块将系统中产生的数据以及用户所拥有的资源汇总；

所述客户端接口测试模块分别与平台的接口管理模块、项目管理模块、通知管理模块连接，将客户端在使用过程中产生的数据交给平台的接口管理模块；将平台的接口按照接口所属的项目环境进行测试，将测试结果发送给平台的通知管理告知相关用户；

所述客户端的授权管理模块与平台的授权管理模块连接，在平台给客户端授权以后，客户端产生的数据才是平台所认可的。

优选的，在上述的一种去中心的接口文档管理平台中，项目管理模块包括：项目成员单元、项目角色单元、成员权限单元、项目环境单元、项目资源单元；项目成员单元存储从用户社交管理的好友邀请加入的用户；项目角色单元是对项目权限的抽象，给用户分配权限；项目环境单元是项目所运行的项目地址，接口测试的接口都在在这个环境下运行；项目资源单元存储项目下定义的服务器地址、账号密码、IP、README相关信息。

优选的，在上述的一种去中心的接口文档管理平台中，社交管理模块包括：添加好友单元、好友分组单元、名片分享单元、消息提醒单元，通过添加好友单元添加好友，并根据用户账号或者名片的方式设置分组，名片分享单元生成名片用于分组或添加好友；消息提醒单元能够提醒系统消息和好友消息。