一种接口文档的生成方法、装置、存储介质及设备制造方法及图纸

本申请公开了一种接口文档的生成方法、装置、存储介质及设备，利用拦截工具对目标系统的请求信息、以及响应信息进行拦截；对请求信息进行分析处理，得到第一分析结果，并将第一分析结果存储至接口记录中；对响应信息进行分析处理，得到第二分析结果，并将第二分析结果存储至接口记录中；对接口记录进行分类处理，得到接口规范集合；将接口规范集合进行转换，得到接口文档，与现有技术相比，能够避免对旧微服务系统进行侵入式修改，开发人员就不需要与旧微服务器的开发维护者进行沟通，因此，提升了工作效率。升了工作效率。升了工作效率。

【技术实现步骤摘要】
一种接口文档的生成方法、装置、存储介质及设备


[0001]本申请涉及接口数据
，尤其涉及一种接口文档的生成方法、装置、存储介质及设备。

技术介绍

[0002]随着Web2.0、分布式系统、微服务架构体系的发展，企业内的多个子系统间或是跨企业的开放平台间的通信变得非常普遍，而各个子系统之间的通信接口有多种协议。
[0003]目前，以RPC协议为代表，各自提供一种接近于编程语言语法的，描述服务端系统所提供的数据模型与服务接口的领域特定语言(Domain Specific Language，DSL)，以充当接口文档。由于RPC协议的框架在使用时，微服务系统先有接口设计，才有基于特定技术栈的接口实现；但是在有接口设计之前，已经有大量的系统及其接口在基于HTTP协议进行交互，而开发人员在实现新微服务系统时，需要与旧微服务系统进行交互，在交互的过程中，需要与旧微服务系统的开发维护者进行沟通，在双方确认方案之后才能进行交互，造成工作效率的低下。
[0004]因此，如何提升工作效率，成为本领域人员亟需解决的问题。

技术实现思路

[0005]本申请提供了一种接口文档的生成方法、装置、存储介质及设备，目的在于提升工作效率。
[0006]为了实现上述目的，本申请提供了以下技术方案：
[0007]一种接口文档的生成方法，包括：
[0008]利用拦截工具对目标系统的请求信息、以及响应信息进行拦截；
[0009]对所述请求信息进行分析处理，得到第一分析结果，并将所述第一分析结果存储至接口记录中；
[0010]对所述响应信息进行分析处理，得到第二分析结果，并将所述第二分析结果存储至所述接口记录中；
[0011]对所述接口记录进行分类处理，得到接口规范集合；
[0012]将所述接口规范集合进行转换，得到接口文档。
[0013]可选的，所述请求信息至少包括：请求路径、请求方法、请求参数信息、请求头信息、请求实体信息；
[0014]所述对所述请求信息进行分析处理，得到第一分析结果，并将所述第一分析结果存储至接口记录中，包括：
[0015]利用路径分隔符将所述请求路径进行切分处理，得到各个路径；
[0016]按照所述路径级数由小到大的顺序，依次对各个所述路径进行参数类型分析，得到与每个所述路径对应的参数类型；
[0017]将每个所述路径替换为与每个所述路径对应的所述参数类型；
[0018]将与每个所述路径对应的所述参数类型进行拼接处理，得到第一接口依据，并将所述第一接口依据存储至所述接口记录中；
[0019]若所述请求方法不为预设请求方法，将所述请求方法标识为第二接口依据，并将所述第二接口依据存储至所述接口记录中；
[0020]对所述请求参数信息进行分析处理，得到各个请求参数、以及所述请求参数对应参数类型，并将各个所述请求参数、以及与所述请求参数对应的所述参数类型存储至所述接口记录中；
[0021]根据所述请求头信息确定第一分析依据，并将所述第一分析依据存储至所述接口记录中；
[0022]依据所述第一分析依据将所述请求实体信息进行转换，得到各个结构体；
[0023]对各个所述结构体进行分析处理，得到各个实体参数、与各个所述实体参数对应的参数类型，并将各个所述实体参数、与所述实体参数对应的所述参数类型存储至所述接口记录中。
[0024]可选的，还包括：
[0025]若所述请求方法为所述预设请求方法，将所述消息队列中的所述请求方法进行删除；所述请求方法预先存储在所述消息队列中。
[0026]可选的，所述响应信息至少包括响应状态码信息、响应头信息、响应实体信息；
[0027]所述对所述响应信息进行分析处理，得到第二分析结果，并将所述第二分析结果存储至所述接口记录中，包括：
[0028]对所述响应状态码信息进行分析处理，得到响应状态码，并将所述响应状态码存储至所述接口记录中；
[0029]根据所述响应头信息确定第二分析依据，并将所述第二分析依据存储至所述接口记录中；
[0030]依据所述第二分析依据对所述响应实体信息进行转换，得到各个目标结构体；
[0031]对各个所述目标结构体进行分析处理，得到各个目标参数、与各个所述目标参数对应的参数类型，并将各个所述目标参数、与所述目标参数对应的所述参数类型存储至所述接口记录中。
[0032]可选的，所述对所述接口记录进行分类处理，得到接口规范集合，包括：
[0033]当所述接口规范集合中未包含所述接口记录所示的第一接口依据时，基于所述第一接口依据生成第一接口规范，并将所述第一接口规范存储至所述接口规范集合中；
[0034]当所述接口规范集合中包含所述接口记录所示的所述第一接口依据时，判断所述接口规范集合中是否未包含所述接口记录所示的第二接口依据；
[0035]若所述接口规范集合中未包含所述接口记录所示的所述第二接口依据，则基于所述第二接口依据生成第二接口规范，并将所述第二接口规范存储至所述接口规范集合中；
[0036]若所述接口规范集合中包含所述接口记录所示的所述第二接口依据，则判断所述接口规范集合中是否未包含所述接口记录所示的第一分析依据；
[0037]若所述接口规范集合中未包含所述接口记录所示的所述第一分析依据，则将所述第一分析依据存储至所述接口规范集合中；
[0038]若所述接口规范集合中包含所述接口记录所示的所述第一分析依据，则对于所述
接口记录所示的各个请求参数，判断所述接口规范集合中是否未包含与所述请求参数对应的参数类型；
[0039]若所述接口规范集合中未包含与所述请求参数对应的所述参数类型，则将与所述请求参数对应的所述参数类型存储至所述接口规范集合中；
[0040]若所述接口规范集合中包含与所述请求参数对应的所述参数类型，则判断所述接口规范集合中是否未包含所述接口记录所示的第二分析依据；
[0041]若所述接口规范集合中未包含所述接口记录所示的所述第二分析依据，则将所述第二分析依据存储所述接口规范集合中；
[0042]若所述接口规范集合中包含所述接口记录所示的所述第二分析依据，则对于所述接口记录的各个目标参数，判断所述接口规范集合中是否未包含与所述目标参数对应的参数类型；
[0043]若所述接口规范集合中未包含与所述目标参数对应的所述参数类型，则将与所述目标参数对应的所述参数类型存储至所述接口规范集合中。
[0044]一种接口文档的生成装置，包括：
[0045]拦截单元，用于利用拦截工具对目标系统的请求信息、以及响应信息进行拦截；
[0046]第一分析单元，用于对所述请求信息进行分析处理，得到第一分析结果，并将所述第一分析结果存储至接口记录中；
[0047]第二分析单元，用于对所述响应信息进行分析处理，得到第二分析结果，并将所述第二分析结果存储至所述接口记录中；本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：利用拦截工具对目标系统的请求信息、以及响应信息进行拦截；对所述请求信息进行分析处理，得到第一分析结果，并将所述第一分析结果存储至接口记录中；对所述响应信息进行分析处理，得到第二分析结果，并将所述第二分析结果存储至所述接口记录中；对所述接口记录进行分类处理，得到接口规范集合；将所述接口规范集合进行转换，得到接口文档。2.根据权利要求1所述的方法，其特征在于，所述请求信息至少包括：请求路径、请求方法、请求参数信息、请求头信息、请求实体信息；所述对所述请求信息进行分析处理，得到第一分析结果，并将所述第一分析结果存储至接口记录中，包括：利用路径分隔符将所述请求路径进行切分处理，得到各个路径；按照所述路径级数由小到大的顺序，依次对各个所述路径进行参数类型分析，得到与每个所述路径对应的参数类型；将每个所述路径替换为与每个所述路径对应的所述参数类型；将与每个所述路径对应的所述参数类型进行拼接处理，得到第一接口依据，并将所述第一接口依据存储至所述接口记录中；若所述请求方法不为预设请求方法，将所述请求方法标识为第二接口依据，并将所述第二接口依据存储至所述接口记录中；对所述请求参数信息进行分析处理，得到各个请求参数、以及所述请求参数对应参数类型，并将各个所述请求参数、以及与所述请求参数对应的所述参数类型存储至所述接口记录中；根据所述请求头信息确定第一分析依据，并将所述第一分析依据存储至所述接口记录中；依据所述第一分析依据将所述请求实体信息进行转换，得到各个结构体；对各个所述结构体进行分析处理，得到各个实体参数、与各个所述实体参数对应的参数类型，并将各个所述实体参数、与所述实体参数对应的所述参数类型存储至所述接口记录中。3.根据权利要求2所述的方法，其特征在于，还包括：若所述请求方法为所述预设请求方法，将所述消息队列中的所述请求方法进行删除；所述请求方法预先存储在所述消息队列中。4.根据权利要求1所述的方法，其特征在于，所述响应信息至少包括响应状态码信息、响应头信息、响应实体信息；所述对所述响应信息进行分析处理，得到第二分析结果，并将所述第二分析结果存储至所述接口记录中，包括：对所述响应状态码信息进行分析处理，得到响应状态码，并将所述响应状态码存储至所述接口记录中；根据所述响应头信息确定第二分析依据，并将所述第二分析依据存储至所述接口记录
中；依据所述第二分析依据对所述响应实体信息进行转换，得到各个目标结构体；对各个所述目标结构体进行分析处理，得到各个目标参数、与各个所述目标参数对应的参数类型，并将各个所述目标参数、与所述目标参数对应的所述参数类型存储至所述接口记录中。5.根据权利要求1所述的方法，其特征在于，所述对所述接口记录进行分类处理，得到接口规范集合，包括：当所述接口规范集合中未包含所述接口记录所示的第一接口依据时，基于所述第一接口依据生成第一接口规范，并将所述第一接口规范存储至所述接口规范集合中；当所述接口规范集合中包含所述接口记录所示的所述第一接口依据时，判断所述接口规范集合中是否未包含所述接口记录所示的第二接口依据；若所述接口规范集合中未包含所述接口记录所示的所述第二接口依据，则基于所述第二接口依据生成第二接口规范，并将所述第二接口规范存储至所述接口规范集合中；若所述接口规范集合中包含所述接口记录所示的所述第二接口依据，则判断所述接口规范集合中是否未包含所述接口记录所示的第一分析依据；若所述接口规范集合中未包含所述接口记录所示的所述第一分析...

【专利技术属性】
技术研发人员：张子穆，
申请(专利权)人：湖南快乐阳光互动娱乐传媒有限公司，
类型：发明
国别省市：