一种HTTP接口管理方法及装置制造方法及图纸

本发明专利技术公开一种HTTP接口管理方法及装置，其包括如下步骤：读取原接口信息；创建扫描注解工具类，并通过注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息；按照HTTP接口编号比较原接口信息和扫描接口信息，判断扫描接口信息与原接口信息是否相同；若不同，则判断原接口信息中是否存在尚未保存的接口信息；若是，则将尚未保存的接口信息添加到原接口信息中；若否，则判断原接口信息中是否存在冗余的接口信息，若是，则在原接口信息删除冗余的接口信息。本发明专利技术通过在HTTP接口中的接口方法上添加预设注解规范，借助扫描注解工具类实时获取扫描接口信息，实现原接口信息与扫描接口信息的同步，解决了人工易遗忘或滞后修改的问题。

An HTTP Interface Management Method and Device

【技术实现步骤摘要】
一种HTTP接口管理方法及装置
本专利技术涉及网络通信领域，具体而言，本专利技术涉及一种HTTP接口管理方法及装置。
技术介绍
在Javaweb项目开发中，为提供特定的业务服务，业务系统通常需要编写超文本传输协议(HyperTextTransferProtocol，简称HTTP)接口，同时，针对编写好的HTTP接口，系统后台还需要配套开发对应接口管理模块，用于查询展示HTTP接口的信息，譬如接口参数、接口返回、接口能力等。接口管理模块需要将接口信息保存到关系型数据库，现有的接口信息存入关系型数据库的传统的方式往往通过人工录入。显然，使用这种方式管理接口信息会存在诸多弊端，假如当线上的HTTP接口发生接口参数变动时，关系型数据库中对应的接口信息也需要进行同步修改，但是人工容易遗忘或滞后修改。为了解决人工处理存在的弊端，部分改进方式是在JavaWeb项目集成Swagger框架，其中，Swagger框架是一个简单又强大具有Restful风格的应用程序编程接口(ApplicationProgrammingInterface，简称API)生成文档工具。在JavaWeb项目中集成这个工具，根据用户的配置信息能够自动生成API展示页，可以在浏览器中直接访问查看JavaWeb项目中的接口信息，但是，该方式通常不能够实现将接口信息自动同步存入关系型数据库的目的，需要用户单独进行定制开发，同步的成本比较高。
技术实现思路
为了寻找更为有效的接口信息同步的实现方案，本专利技术提供了一种具有良好接口信息同步的HTTP接口管理方法及装置。为实现上述目的，本专利技术提供一种HTTP接口管理方法，其包括如下步骤：读取存储在关系数据库中的原接口信息；创建扫描注解工具类，并通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息；按照HTTP接口编号比较所述原接口信息和所述扫描接口信息，判断所述扫描接口信息与所述原接口信息是否相同；若所述扫描接口信息与所述原接口信息不相同，则判断所述原接口信息中是否存在尚未保存的接口信息；若是，则将所述尚未保存的接口信息添加到所述原接口信息中；若否，则判断所述原接口信息中是否存在冗余的接口信息，若是，则在所述原接口信息删除所述冗余的接口信息。优选地，所述通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息之前，包括如下步骤：定义预设注解规范，所述预设注解规范的字段包括接口编号、接口名称、接口地址、参数说明、接口描述、接口类别、接口类型、是否删除的一种或者多种；获取HTTP接口，并在所述HTTP接口中的接口方法上添加所述预设注解规范。优选地，所述通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息，包括如下步骤：定义待扫描包，所述待扫描包包括JAVA类以及JAVA类中定义的接口方法；遍历已定义的待扫描包，并将所述待扫描包的包路径转化为预设操作系统文件路径；获取JAVA类并识别所述JAVA类中定义的接口方法中是否存在所述预设注解规范，若存在，则读取所述预设注解规范中的字段，得到扫描接口信息。优选地，所述判断所述扫描接口信息与所述原接口信息是否相同包括如下步骤：将原接口信息中的各个字段相加后计算原接口MD5值；将读取的所述预设注解规范中的各个字段相加后计算扫描接口MD5值；比较所述原接口MD5值和所述扫描接口MD5值，若所述原接口MD5值和所述扫描接口MD5值相同，则所述扫描接口信息与所述原接口信息相同。优选地，所述所述扫描接口信息与所述原接口信息相同之后，还包括如下步骤：获取HTTP接口的变动信息，基于所述变动信息和所述预设注解规范调整添加在所述HTTP接口中的接口方法上的预设注解规范。基于同一个专利技术构思，本专利技术还提供一种HTTP接口管理装置，其包括：读取模块，用于读取存储在关系数据库中的原接口信息；创建扫描模块，用于创建扫描注解工具类，并通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息；比较判断模块，用于按照HTTP接口编号比较所述原接口信息和所述扫描接口信息，判断所述扫描接口信息与所述原接口信息是否相同；添加模块，用于在所述扫描接口信息与所述原接口信息不相同时，判断所述原接口信息中是否存在尚未保存的接口信息；若是，则将所述尚未保存的接口信息添加到所述原接口信息中；删除模块，用于在所述原接口信息中不存在尚未保存的接口信息时，判断所述原接口信息中是否存在冗余的接口信息，若是，则在所述原接口信息删除所述冗余的接口信息。优选地，所述HTTP接口管理装置包括：预设模块，用于在通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息之前定义预设注解规范，所述预设注解规范的字段包括接口编号、接口名称、接口地址、参数说明、接口描述、接口类别、接口类型、是否删除的一种或者多种；注解模块，用于获取HTTP接口，并在所述HTTP接口中的接口方法上添加所述预设注解规范。优选地，所述创建扫描模块包括：定义单元，用于定义待扫描包，所述待扫描包包括JAVA类以及JAVA类中定义的接口方法；遍历转换单元，用于遍历已定义的待扫描包，并将所述待扫描包的包路径转化为预设操作系统文件路径；字段读取单元，用于获取JAVA类并识别所述JAVA类中定义的接口方法中是否存在所述预设注解规范，若存在，则读取所述预设注解规范中的字段，得到扫描接口信息。优选地，所述比较判断模块包括：原接口计算单元，用于将原接口信息中的各个字段相加后计算原接口MD5值；扫描接口计算单元，用于将读取的所述预设注解规范中的各个字段相加后计算扫描接口MD5值；比较单元，用于比较所述原接口MD5值和所述扫描接口MD5值，若所述原接口MD5值和所述扫描接口MD5值相同，则所述扫描接口信息与所述原接口信息相同。优选地，所述HTTP接口管理装置包括：变动模块，用于在所述扫描接口信息与所述原接口信息相同之后获取HTTP接口的变动信息，基于所述变动信息和所述预设注解规范调整添加在所述HTTP接口中的接口方法上的预设注解规范。与现有技术相比，本专利技术一种HTTP接口管理方法及装置具有如下有益效果：本专利技术一种HTTP接口管理方法及装置通过在HTTP接口中的接口方法上添加预设注解规范，再借助扫描注解工具类实时获取扫描接口信息，并将其与关系数据库中的原接口信息进行比对来更新原接口信息的方式，实现了原接口信息与扫描接口信息的同步，不仅方便了项目调用，还在一定程度上克服了人工容易遗忘或滞后修改的问题。本专利技术附加的方面和优点将在下面的描述中部分给出，这些将从下面的描述中变得明显，或通过本专利技术的实践了解到。附图说明本专利技术上述的和/或附加的方面和优点从下面结合附图对实施例的描述中将变得明显和容易理解，其中：图1为本专利技术实施例一种HTTP接口管理方法的流程示意图；图2为本专利技术实施例一种HTTP接口管理装置的模块结构示意图。具体实施方式下面详细描述本专利技术的实施例，所述实施例的示例在附图中示出，其中自始至终相同或类似的标号表示相同或类似的元件或具有相同或类似功能的元件。下面通过参考附图描述的实施例是示例性的，仅用于解释本专利技术，而不能解释为对本专利技术的限制。请参阅图1，图1示出了本专利技术实施例一种HTTP接口管理本文档来自技高网...

【技术保护点】
1.一种HTTP接口管理方法，其特征在于，所述HTTP接口管理方法包括如下步骤：读取存储在关系数据库中的原接口信息；创建扫描注解工具类，并通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息；按照HTTP接口编号比较所述原接口信息和所述扫描接口信息，判断所述扫描接口信息与所述原接口信息是否相同；若所述扫描接口信息与所述原接口信息不相同，则判断所述原接口信息中是否存在尚未保存的接口信息；若是，则将所述尚未保存的接口信息添加到所述原接口信息中；若否，则判断所述原接口信息中是否存在冗余的接口信息，若是，则在所述原接口信息删除所述冗余的接口信息。

【技术特征摘要】
1.一种HTTP接口管理方法，其特征在于，所述HTTP接口管理方法包括如下步骤：读取存储在关系数据库中的原接口信息；创建扫描注解工具类，并通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息；按照HTTP接口编号比较所述原接口信息和所述扫描接口信息，判断所述扫描接口信息与所述原接口信息是否相同；若所述扫描接口信息与所述原接口信息不相同，则判断所述原接口信息中是否存在尚未保存的接口信息；若是，则将所述尚未保存的接口信息添加到所述原接口信息中；若否，则判断所述原接口信息中是否存在冗余的接口信息，若是，则在所述原接口信息删除所述冗余的接口信息。2.如权利要求1所述的HTTP接口管理方法，其特征在于，所述通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息之前，包括如下步骤：定义预设注解规范，所述预设注解规范的字段包括接口编号、接口名称、接口地址、参数说明、接口描述、接口类别、接口类型、是否删除的一种或者多种；获取HTTP接口，并在所述HTTP接口中的接口方法上添加所述预设注解规范。3.如权利要求2所述的HTTP接口管理方法，其特征在于，所述通过所述注解扫描工具类扫描已注解预设注解规范的HTTP接口，得到扫描接口信息，包括如下步骤：定义待扫描包，所述待扫描包包括JAVA类以及JAVA类中定义的接口方法；遍历已定义的待扫描包，并将所述待扫描包的包路径转化为预设操作系统文件路径；获取JAVA类并识别所述JAVA类中定义的接口方法中是否存在所述预设注解规范，若存在，则读取所述预设注解规范中的字段，得到扫描接口信息。4.如权利要求3所述的HTTP接口管理方法，其特征在于，所述判断所述扫描接口信息与所述原接口信息是否相同包括如下步骤：将原接口信息中的各个字段相加后计算原接口MD5值；将读取的所述预设注解规范中的各个字段相加后计算扫描接口MD5值；比较所述原接口MD5值和所述扫描接口MD5值，若所述原接口MD5值和所述扫描接口MD5值相同，则所述扫描接口信息与所述原接口信息相同。5.如权利要求4所述的HTTP接口管理方法，其特征在于，所述所述扫描接口信息与所述原接口信息相同之后，还包括如下步骤：获取HTTP接口的变动信息，基于所述变动信息和所述预设注解规范调整添加在所述HTTP接口中的接口方法上的预设注解规范。6.一种HTTP接口管理装置，其特征在于，所述HTTP接口管理装置包括：读取模块，...

【专利技术属性】
技术研发人员：左骏，朱家健，张冲，张琦，
申请(专利权)人：上海卓繁信息技术股份有限公司，
类型：发明
国别省市：上海,31