[发明专利]优化web应用系统开发的方法及web前端项目结构

权利要求书

1.一种优化web应用系统开发的方法，用于提升web应用前后端定义与对接API的效率，其特征在于，包括：

通过Swagger统一web应用开发前后端接口定义与对接的规范与风格，使用Java作为开发语言，并使用springboot或springmvc作为开发框架；

在web应用后端定义API并集成Swagger，同时，通过Swagger生成对应的web接口文档和接口类型定义文件；

在web应用前端使用有javascript运行能力的引擎作为开发必须的支持环境，web应用前端实时查看并获取所述web应用后端生成的web接口文档和接口类型定义文件，并通过javascript或Typescrip语言编写的脚本将所述接口类型定义文件转为web应用前端开发中可用的接口方法。

2.根据权利要求1所述的一种优化web应用系统开发的方法，其特征在于，所述web应用后端集成Swagger并生成对应的web接口文档和接口类型定义文件时具体包括以下步骤：

S1.所述web应用后端采用可以集成Swagger框架的语言作为开发语言并采用可以集成Swagger的框架作为开发框架；

S2.所述web应用后端通过集成Swagger，在定义API的过程中生成详细的接口类型定义文件并通过Swagger UI将此接口类型定义文件以web页面形式作为展现，直接作为web形式的web接口文档。

3.根据权利要求2所述的一种优化web应用系统开发的方法，其特征在于，所述接口类型定义文件是通过Swagger生成的能定义详细数据结构以及类型的文档。

4.根据权利要求3所述的一种优化web应用系统开发的方法，其特征在于，所述接口类型定义文件中包括：接口的请求host、公有请求路径、每个详细的API模块私有请求路径、对每个详细的API模块分别包含或部分包含增删改查的数据操作方式、对每一种操作中包含对应的请求参数名称以及类型定义、对每一种操作中包含对应的请求参数所处位置定义、对每一种操作定义进行全部定义或部分定义请求接口的返回状态码以及对应的返回数据格式及内容。

5.根据权利要求4所述的一种优化web应用系统开发的方法，其特征在于，所述web应用前端具体使用node作为前端开发的环境支持，且web应用前端使用Typescript作为前端开发语言，通过nodeJs运行脚本的方式以网络请求获取接口类型定义文件，且所述web应用前端开发中可用的接口方法为Typescript方法。

6.根据权利要求5所述的一种优化web应用系统开发的方法，其特征在于，通过javascript或Typescrip语言编写的脚本将所述接口类型定义文件转为web应用前端开发中可用的接口方法时，所述脚本通过nodeJs执行，且包括以下步骤：

S1.所述脚本根据web应用后端集成Swagger后产生服务的网络地址，使用nodeJs的request模块请求所述接口类型定义文件；

S2.所述脚本将接口类型定义文件转为针对一个个独立的API访问方法来访问web应用后端的参数结构与类型定义，并以所述API访问方法的形参结构与类型来展现。

7.根据权利要求6所述的一种优化web应用系统开发的方法，其特征在于，所述步骤S2中脚本将接口类型定义文件转为针对一个个独立的API访问方法时，具体包括以下步骤：

S101.提取所述接口类型定义文件的公有请求路径组成API的基础访问路径；

S102.按一定顺序提取每个详细的API模块私有请求路径，并遍历对应请求类型，以小驼峰的方式组成对每个详细的API模块每种请求方式的API访问方法的方法名；

S103.根据所述web应用后端定义的参数位置类型生成所述API访问方法的参数的传递类型；

S104.根据所述返回状态码以及对应的返回数据格式及内容，定义所述API访问方法的返回值与类型；

S105.结合所述web前端使用的网络请求架构，将对应的网络请求方法注入到每个所述API访问方法中。