一种接口文档生成方法、系统、电子设备及存储介质技术方案

本发明专利技术提出一种接口文档生成方法、系统、电子设备及存储介质，其方法技术方案包括开发环境配置步骤，在一Java集成开发环境中配置EasyYapi插件；规范框架配置步骤，在所述Java集成开发环境中的一Java项目中，添加一Swagger规范框架依赖，并将所述EasyYapi插件和所述Swagger规范框架依赖进行整合；接口文档生成步骤，通过所述EasyYapi插件上传接口信息并在Yapi上生成接口文档。本申请解决了现有前后端接口协调方法准确性、实时性和详细性较差的问题。差的问题。差的问题。

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


[0001]本专利技术属于接口
，尤其涉及一种接口文档生成方法、系统、电子设备及存储介质。

技术介绍

[0002]随着互联网的高速发展，前端页面的展示、交互体验越来越灵活、炫丽，响应体验也要求越来越高，后端服务的高并发、高可用、高性能、高扩展等特性的要求也愈加严格，从而导致前后端研发各自专注于自己擅长的领域深耕细作，前后端分离已成为互联网项目开发的业界标准使用方式。
[0003]前后端分离的优势是一套api可被多个客户端复用，分工和协作被细化，大大提高了编码效率。然而与此同时带来了另一个问题：双方之间关注甚少，在没有任何api(Application Programming Interface，即应用程序编程接口)约定规范情况下各自为政，导致在产品项目开发过程中，前后端的api联调对接工作量占比在30％
‑
50％左右，甚至会更高。如何提高前后端api联调对接工作效率成为整个产品项目研发的关键。
[0004]为了解决上述问题，基于api文档的开发前后端协作方式应运而生，后端编写和维护接口文档，在api变化时更新接口文档；后端根据接口文档进行接口开发；前端根据接口文档进行开发+Mock(数据模拟)平台；开发完成后联调和提交测试。通过接口文档，开发时，前后端工程师有一个统一的文件进行沟通交流开发；维护时，可以方便后期人员查看和维护。
[0005]但在现有技术中，传统的接口文档产出，基本上是由后端进行手工编写。在编写文档过程中，由于人为的粗心大意，造成接口文档某个字段，或者某个接口名写错，这些错误就会影响后续的联调操作。在项目开发过程中，当后端人员提供了一份接口文档，并且与前端人员联调也通过了，但是由于需求变更，导致后端接口发生了变化，而后端人员有可能懒，又没有实时的去更新接口文档，那么前端人员就无法根据最新的接口文档进行修改，从而无法有效的完成整个项目的需求变更。在进行接口文档编写时，基本上都会有一个标准，包括接口名、方法类型、入参、入参类型，返回值，返回值的各种情况说明等等。一般公司都会通过接口文档规范来强制大家按照要求编写，但是理想很美好，现实很残酷。随着时间推移，项目迭代次数过多，或者项目周期赶等等因素，大家很难能够完全按照规范来编写接口文档。由于接口文档的不够规范，描述不够详细，对于接口文档的需求方会造成困扰。

技术实现思路

[0006]本申请实施例提供了一种接口文档生成方法、系统、电子设备及存储介质，以至少解决现有前后端接口协调方法准确性、实时性和详细性较差的问题。
[0007]第一方面，本申请实施例提供了一种接口文档生成方法，包括：开发环境配置步骤，在一Java集成开发环境中配置EasyYapi插件；规范框架配置步骤，在所述Java集成开发环境中的一Java项目中，添加一Swagger规范框架依赖，并将所述EasyYapi插件和所述
Swagger规范框架依赖进行整合；接口文档生成步骤，通过所述EasyYapi插件上传接口信息并在Yapi上生成接口文档。
[0008]优选的，所述规范框架配置步骤进一步包括：在所述Java项目中，通过pom文件引入Swagger依赖，并在项目程序启动入口Application上添加@EnableOpenApi注解，进一步在所述接口信息添加Swagger配置以添加所述Swagger规范框架依赖。
[0009]优选的，所述规范框架配置步骤进一步包括：所述Swagger配置包括注解@Api和@ApiOperation，其中，所述注解@Api用于接口大类，所述注解@ApiOperation用于具体接口。
[0010]优选的，所述接口文档生成步骤进一步包括：若所述接口信息发生变更，则重复执行所述接口文档生成步骤对所述Yapi上的所述接口文档进行更新。
[0011]第二方面，本申请实施例提供了一种接口文档生成系统，适用于上述一种接口文档生成方法，包括：开发环境配置模块，在一Java集成开发环境中配置EasyYapi插件；规范框架配置模块，在所述Java集成开发环境中的一Java项目中，添加一Swagger规范框架依赖，并将所述EasyYapi插件和所述Swagger规范框架依赖进行整合；接口文档生成模块，通过所述EasyYapi插件上传接口信息并在Yapi上生成接口文档。
[0012]在其中一些实施例中，所述规范框架配置模块进一步包括：在所述Java项目中，通过pom文件引入Swagger依赖，并在项目程序启动入口Application上添加@EnableOpenApi注解，进一步在所述接口信息添加Swagger配置以添加所述Swagger规范框架依赖。
[0013]在其中一些实施例中，所述规范框架配置模块进一步包括：所述Swagger配置包括注解@Api和@ApiOperation，其中，所述注解@Api用于接口大类，所述注解@ApiOperation用于具体接口。
[0014]在其中一些实施例中，所述接口文档生成模块进一步包括：若所述接口信息发生变更，则重复执行所述接口文档生成模块对所述Yapi上的所述接口文档进行更新。
[0015]第三方面，本申请实施例提供了一种电子设备，包括存储器、处理器以及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如上述第一方面所述的一种接口文档生成方法。
[0016]第四方面，本申请实施例提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现如上述第一方面所述的一种接口文档生成方法。
[0017]本申请可应用于数据能力
相比于相关技术，本申请实施例提供的一种接口文档生成方法，从实际产品项目开发问题出发，为了解决产品项目开发中碰到的api文档与实际代码不一致、根据需求变更不及时、描述不够规范详细等问题，基于java SpringBoot项目，通过Swagger规范框架和EasyYapi插件，将代码自动部署到Yapi接口管理平台上，实现了一种准确，高效的产品项目api文档的自动生成方法。相对于其他的api文档生成方法，有如下优点：
[0018]1.当api发生改变时，修改灵活；
[0019]2.后端代码修改，前端能够通过自动生成的api文档实时感知到变动；
[0020]3.产品项目代码与api文档时刻保持一致。
附图说明
[0021]此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申
请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：
[0022]图1为本专利技术的接口文档生成方法流程图；
[0023]图2为本专利技术的接口文档生成系统的框架图；
[0024]图3为本专利技术的电子设备的框架图；
[0025]以上图中：
[0026]1、开发环境配置模块；2、规范框架配置模块；3、接口文档生成模块；60本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：开发环境配置步骤，在一Java集成开发环境中配置EasyYapi插件；规范框架配置步骤，在所述Java集成开发环境中的一Java项目中，添加一Swagger规范框架依赖，并将所述EasyYapi插件和所述Swagger规范框架依赖进行整合；接口文档生成步骤，通过所述EasyYapi插件上传接口信息并在Yapi上生成接口文档。2.根据权利要求1所述的接口文档生成方法，其特征在于，所述规范框架配置步骤进一步包括：在所述Java项目中，通过pom文件引入Swagger依赖，并在项目程序启动入口Application上添加@EnableOpenApi注解，进一步在所述接口信息添加Swagger配置以添加所述Swagger规范框架依赖。3.根据权利要求2所述的接口文档生成方法，其特征在于，所述规范框架配置步骤进一步包括：所述Swagger配置包括注解@Api和@ApiOperation，其中，所述注解@Api用于接口大类，所述注解@ApiOperation用于具体接口。4.根据权利要求1所述的接口文档生成方法，其特征在于，所述接口文档生成步骤进一步包括：若所述接口信息发生变更，则重复执行所述接口文档生成步骤对所述Yapi上的所述接口文档进行更新。5.一种接口文档生成系统，其特征在于，包括：开发环境配置模块，在一Java集成开发环境中配置EasyYapi插件；规范框架配置模块，在所述Java集成开发环境中的一Ja...

【专利技术属性】
技术研发人员：肖光昭，高阳，
申请(专利权)人：北京明略昭辉科技有限公司，
类型：发明
国别省市：