【技术实现步骤摘要】
本专利技术涉及软件开发领域，具体提供一种基于node的后端接口文档生成方法及装置。
技术介绍
1、目前在软件开发领域，前后端分离开发的形式越来越多，随之而来的就是在进行联合调试和前端页面交互时前后端工程师的交流成本的增加，目前主流的开发模式主要是：
2、(1)后端开发工程师在开发接口的时候同时利用swigger或apifox之类的第三方插件或者程序包进行后端的接口文档书写；
3、(2)前端开发工程师在拿到后端开发工程师的接口文档之后，根据接口文档的说明，书写前端的交互请求函数；
4、(3)前端开发工程师在业务代码中，调用(2)中的交互请求函数实现前端页面和后端的交互。
5、目前这种的开发模式存在着工程师重复书写代码的弊端、以及严重加大了工程师的心智负担和交流成本以及出错的概率。
技术实现思路
1、本专利技术是针对上述现有技术的不足，提供一种实用性强的基于node的后端接口文档生成方法。
2、本专利技术进一步的技术任务是提供一种设计合理，安全适用的基于node的后端接口文档生成装置。
3、本专利技术解决其技术问题所采用的技术方案是：
4、一种基于node的后端接口文档生成方法，具有如下步骤：
5、s1、在前端开发环境中引入node的fs模块；
6、s2、利用fs模块对文件的操作能力，循环读取项目中后端代码的controller.java文件；
7、s3、设计前端进行
8、s4、配置前端代码构建工具，生成api.js文件。
9、进一步的，所述node，即node.js是一个开源、跨平台的javascript运行时环境。
10、进一步的，在步骤s2中，利用fs模块对文件的操作能力，循环读取项目中后端代码的controller.java文件，设计符合预期的javascript函数，读取controller.java文件中的接口路径、入参和说明存入内存中。
11、进一步的，所述fs模块为node.js提供，用来操作文件的读取和写入，提供属性和方法，满足用户对文件的操作。
12、进一步的，所述controller.java文件，是后端把用户提交来的请求通过对url的匹配，分配个不同的接收器，再进行处理，然后向用户返回结果的组件。
13、进一步的，在步骤s3中，将读取到的controller文件中的接口路径存储在内存中，利用fs模块操作文件的功能构建合适的函数方法将内存中的接口路径循环写入api.js文件。
14、进一步的，所述api.js文件是前端基于javascript请求后端完成页面交互所需要依赖第三方插件的函数文件，前端在业务代码中通过引入调用的方式执行文件中的一个或者多个方法。
15、进一步的，在步骤s4中，配置前端代码构建工具，在进行启动或者打包命令的时候利用钩子函数事先执行步骤s3中的函数，生成api.js文件，再执行运行或者打包命令。
16、进一步的，所述钩子函数是指在前端开发工具提供的在生命周期中的某个阶段或者执行到某个阶段所触发调用的函数。
17、一种基于node的后端接口文档生成装置，包括：至少一个存储器和至少一个处理器；
18、所述至少一个存储器，用于存储机器可读程序；
19、所述至少一个处理器，用于调用所述机器可读程序，执行一种基于node的后端接口文档生成方法。
20、本专利技术的一种基于node的后端接口文档生成方法及装置和现有技术相比，具有以下突出的有益效果：
21、本专利技术可以帮助后端开发工程师在controller代码书写的过程中减少心智负担，保证代码的整洁、减少非业务代码的书写，以及减少接口文档书写出错的概率。
22、帮助前端开发工程师在开发工程中减少在开发中的心智负担，可以大幅度减少工程师书写交互接口函数的工作，可以帮助工程师更好的书写业务代码，减少辅助类代码量；
23、在项目运行和打包的时候自动生成所需要的接口方法，减少工程师出错的概率，一定程度上减少系统bug的出现。
本文档来自技高网...【技术保护点】
1.一种基于Node的后端接口文档生成方法，其特征在于，具有如下步骤：
2.根据权利要求1所述的一种基于Node的后端接口文档生成方法，其特征在于，所述Node，即node.js是一个开源、跨平台的JavaScript运行时环境。
3.根据权利要求2所述的一种基于Node的后端接口文档生成方法，其特征在于，在步骤S2中，利用fs模块对文件的操作能力，循环读取项目中后端代码的controller.java文件，设计符合预期的JavaScript函数，读取controller.java文件中的接口路径、入参和说明存入内存中。
4.根据权利要求3所述的一种基于Node的后端接口文档生成方法，其特征在于，所述fs模块为Node.js提供，用来操作文件的读取和写入，提供属性和方法，满足用户对文件的操作。
5.根据权利要求4所述的一种基于Node的后端接口文档生成方法，其特征在于，所述controller.java文件，是后端把用户提交来的请求通过对URL的匹配，分配个不同的接收器，再进行处理，然后向用户返回结果的组件。
6.根据权
7.根据权利要求6所述的一种基于Node的后端接口文档生成方法，其特征在于，所述api.js文件是前端基于JavaScript请求后端完成页面交互所需要依赖第三方插件的函数文件，前端在业务代码中通过引入调用的方式执行文件中的一个或者多个方法。
8.根据权利要求7所述的一种基于Node的后端接口文档生成方法，其特征在于，在步骤S4中，配置前端代码构建工具，在进行启动或者打包命令的时候利用钩子函数事先执行步骤S3中的函数，生成api.js文件，再执行运行或者打包命令。
9.根据权利要求8所述的一种基于Node的后端接口文档生成方法，其特征在于，所述钩子函数是指在前端开发工具提供的在生命周期中的某个阶段或者执行到某个阶段所触发调用的函数。
10.一种基于Node的后端接口文档生成装置，其特征在于，包括：至少一个存储器和至少一个处理器；
...【技术特征摘要】
1.一种基于node的后端接口文档生成方法，其特征在于，具有如下步骤：
2.根据权利要求1所述的一种基于node的后端接口文档生成方法，其特征在于，所述node，即node.js是一个开源、跨平台的javascript运行时环境。
3.根据权利要求2所述的一种基于node的后端接口文档生成方法，其特征在于，在步骤s2中，利用fs模块对文件的操作能力，循环读取项目中后端代码的controller.java文件，设计符合预期的javascript函数，读取controller.java文件中的接口路径、入参和说明存入内存中。
4.根据权利要求3所述的一种基于node的后端接口文档生成方法，其特征在于，所述fs模块为node.js提供，用来操作文件的读取和写入，提供属性和方法，满足用户对文件的操作。
5.根据权利要求4所述的一种基于node的后端接口文档生成方法，其特征在于，所述controller.java文件，是后端把用户提交来的请求通过对url的匹配，分配个不同的接收器，再进行处理，然后向用户返回结果的组件。
6.根据权利要求5所述...
【专利技术属性】
技术研发人员：张乃峰，单震，
申请(专利权)人：浪潮卓数大数据产业发展有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。