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

本发明专利技术公开了一种接口文档的生成方法、装置、计算机设备及存储介质，该方法包括：获取系统分类名对应的代码文件；扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息以及所述代码文件中的实体类以获取所述实体类的注释信息；根据所述接口调用信息和注释信息生成接口记录信息；获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；根据所述入参信息记录表和返回信息记录表生成接口文档。由此方便了前后端的开发人员的沟通，提高了软件系统的开发效率。

【技术实现步骤摘要】
接口文档的生成方法、装置、计算机设备及存储介质
本专利技术涉及互联网
，尤其涉及一种接口文档的生成方法、装置、计算机设备及存储介质。
技术介绍
目前，随着移动互联网的发展以及客户的需求，互联网企业需要提供支持Android、IOS、Web、手机Wap和微信等多个客户端来为用户提供服务，因此前后端分离的开发模式变成了主流的开发模式。前后端分离的开发模式更有利于大型软件系统开发的协作分工，提高开发速度，但是也带来了多个用户(前端开发人员、后台开发人员和测试人员)之间的沟通不便。如何保证不同端的开发人员或测试人员沟通的准确性和沟通效率，成为了大多数互联网公司急需解决的难题。因此有必要提供一种接口文档的生成方法以解决上述问题。
技术实现思路
本专利技术提供了一种接口文档的生成方法、装置、计算机设备及存储介质，旨在提高软件开发的效率。本专利技术提供了一种接口文档的生成方法，其包括：获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息；扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，以及扫描所述代码文件中的实体类以获取所述实体类的注释信息；根据所述接口调用信息和注释信息生成接口记录信息；获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；根据所述入参信息记录表和返回信息记录表生成接口文档。本专利技术提供了一种接口文档的生成装置，其包括：文件获取单元，用于获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息；扫描获取单元，用于扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，以及扫描所述代码文件中的实体类以获取所述实体类的注释信息；信息生成单元，用于根据所述接口调用信息和注释信息生成接口记录信息；信息获取单元，用于获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；记录表生成单元，用于基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；文档生成单元，用于根据所述入参信息记录表和返回信息记录表生成接口文档。本专利技术还提供了一种计算机设备，其包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述程序时实现本专利技术提供的任意实施例的接口文档的生成方法的步骤。本专利技术还提供了一种存储介质，其中所述存储介质存储有计算机程序，所述计算机程序被处理器执行时使所述处理器执行本专利技术提供的任意实施例的接口文档的生成方法的步骤。本专利技术实施例提供了接口文档的生成方法、装置、计算机设备及存储介质，通过获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息；扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，以及扫描所述代码文件中的实体类以获取所述实体类的注释信息；根据所述接口调用信息和注释信息生成接口记录信息；获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；根据所述入参信息记录表和返回信息记录表生成接口文档。该方法生成的接口文档方便了前后端的开发人员的沟通，由此提高了软件系统的开发效率。附图说明为了更清楚地说明本专利技术实施例技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图是本专利技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。图1是本专利技术一实施例提供的一种接口文档的生成方法的示意流程图；图2是本专利技术另一实施例提供的一种接口文档的生成方法的示意流程图；图3是本专利技术又一实施例提供的一种接口文档的生成方法的示意流程图；图4是本专利技术一实施例提供的一种接口文档的生成装置的示意性框图；图5是本专利技术一实施例提供的一种计算机设备的示意性框图。具体实施方式下面将结合本专利技术实施例中的附图，对本专利技术实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本专利技术一部分实施例，而不是全部的实施例。基于本专利技术中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本专利技术保护的范围。应当理解，当在本说明书和所附权利要求书中使用时，术语“包括”和“包含”指示所描述特征、整体、步骤、操作、元素和/或组件的存在，但并不排除一个或多个其它特征、整体、步骤、操作、元素、组件和/或其集合的存在或添加。还应当理解，在此本专利技术说明书中所使用的术语仅仅是出于描述特定实施例的目的而并不意在限制本专利技术。如在本专利技术说明书和所附权利要求书中所使用的那样，除非上下文清楚地指明其它情况，否则单数形式的“一”、“一个”及“该”意在包括复数形式。还应当进一步理解，在本专利技术说明书和所附权利要求书中使用的术语“和/或”是指相关联列出的项中的一个或多个的任何组合以及所有可能组合，并且包括这些组合。请参阅图1，图1是本专利技术一实施例提供的一种接口文档的生成方法的示意流程图。该接口文档的生成方法可应用于服务器中，如图1所示，该生成方法包括步骤S101～S106。S101、获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息。在本实施例中，所述系统分类名为用户开发的系统软件所对应的名称，比如认证服务软件，其对应的系统分类名为认证服务。该认证服务软件会包括代码文件，该代码文件存储在微服务系统中。其中该代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息，预设的注释信息为开发人员在实体类上添加的参数信息注释和在Controller接口上添加的接口信息注释。譬如，开发人员编写实体类的代码时可以在实体类代码上添加参数信息注释，该参数信息注释包括各个属性的含义描述及详细介绍，例如：账号信息中的用户类型属性可以添加注释信息：@ApiField(name＝"用户类型"，remark＝"1:普通用户，2:client")。表示参数含义为用户类型，备注信息包括有哪几种用户类型。再譬如，在Controller接口代码中可以添加接口信息注释，该接口信息注释表示接口的描述信息及备注信息。例如：@RequestMapping("/login")@ApiMethod(name＝"登录"，requires＝{"userId"，"pas本文档来自技高网...

【技术保护点】
1.一种接口文档的生成方法，其特征在于，包括：获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息；扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，以及扫描所述代码文件中的实体类以获取所述实体类的注释信息；根据所述接口调用信息和注释信息生成接口记录信息；获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；根据所述入参信息记录表和返回信息记录表生成接口文档。

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：获取系统分类名对应的代码文件，所述代码文件包括Controller接口和实体类，所述Controller接口和实体类均包括预设的注释信息；扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，以及扫描所述代码文件中的实体类以获取所述实体类的注释信息；根据所述接口调用信息和注释信息生成接口记录信息；获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息；基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表；根据所述入参信息记录表和返回信息记录表生成接口文档。2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息，扫描所述代码文件中的实体类以获取所述实体类的注释信息，包括：根据第一预设关键字扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息；以及根据第二预设关键字扫描所述代码文件中的实体类以获取所述实体类的注释信息。3.根据权利要求1所述的接口文档的生成方法，其特征在于，在所述获取系统分类名对应的代码文件之前，还包括：接收终端发送的文档生成指令，所述文档生成指令为所述终端根据用户输入的系统分类名而生成的指令。4.根据权利要求1所述的接口文档的生成方法，其特征在于，所述接口调用信息包括URL链接地址；所述基于所述接口记录信息，根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表，包括：基于所述URL链接地址，根据所述Controller接口的注释信息、入参信息和所述实体类的注释信息生成与所述URL链接地址对应的入参信息记录表，以及根据所述返回信息和所述实体类的注释信息生成与所述URL链接地址对应的返回信息记录表。5.根据权利要求4所述的接口文档的生成方法，其特征在于，在所述根据所述入参信息记录表和返回信息记录表生成接...

【专利技术属性】
技术研发人员：胡山泉，刘清有，张翼，
申请(专利权)人：深圳市小牛在线互联网信息咨询有限公司，
类型：发明
国别省市：广东,44