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

说明书

本发明公开了一种优化web应用系统开发的方法，包括：通过Swagger统一web应用开发前后端接口定义与对接的规范与风格，使用Java作为开发语言，并使用springboot或springmvc作为开发框架；在web应用后端定义API并集成Swagger，通过Swagger生成对应的web接口文档和接口类型定义文件；在web应用前端使用有javascript运行能力的引擎作为开发的支持环境，web应用前端查看并获取web应用后端生成的web接口文档和接口类型定义文件，通过脚本将接口类型定义文件转为web应用前端开发中可用的接口方法。本发明方法通过统一web应用前后端定义API的框架，使用Swagger作为桥梁起到简化流程、提高效率的效果。

技术领域

本发明涉及使用Typescript开发web应用的前后端研发技术领域，特别涉及一种优化web应用系统开发的方法及web前端项目结构。

背景技术

目前市场上web应用普遍流行使用前后端分离的开发技术，即前后端同时进行开发，此种开发模式使前后端能够并发的进行工作，加快项目的诞生。但在此种模式下定义API以及前后端的沟通与对接会消耗大量的时间。

在web后端的开发领域，Java一直占有很大的比例，截止到目前，多采用springmvc(或springboot)作为开发框架，maven作为包管理，使用Swagger作为定义RESTFUL接口的API框架。

web应用前端开发自前后端独立开发后有较大的发展，特别是node的诞生使得前端的开发人员能更加独立的开发。目前，常采用nodeJs作为前端页面开发的支持环境，使用React/Vue/Angular作为开发框架。但在实际开发中Javascript的弱类型一直饱受诟病，很多问题不能及时发现和解决，只能通过全面测试或者上线问题暴露后再解决。在此种环境下，Typescript的应运而生使得前端开发又进一步。

发明内容

本发明的目的是克服上述背景技术中不足并基于上述背景技术，提供一种优化web应用系统开发的方法及web前端项目结构，旨在以目前主流开发技术的环境下，使web应用前后端的开发者能减少接口定义以及沟通成本,从而更多的关注自身业务研发。

为了达到上述的技术效果，本发明采取以下技术方案：

一种优化web应用系统开发的方法，用于优化web应用系统开发的方法，包括：

通过Swagger统一web应用开发前后端接口定义与对接的规范与风格，使用Java作为开发语言，并使用springboot或springmvc作为开发框架；实际中，也可选用其他可以继承Swagger的开发语言或框架；

在web应用后端定义API并集成Swagger，同时，通过Swagger生成对应的web接口文档和接口类型定义文件；其中，具体是通过注解或其他方式自动生成如json、yaml或其他类型的web接口文档；

在web应用前端使用有javascript运行能力的引擎如nodeJs作为开发必须的支持环境，web应用前端实时查看并获取所述web应用后端生成的web接口文档和接口类型定义文件，并通过javascript或Typescrip语言编写的脚本将所述接口类型定义文件转为web应用前端开发中可用的接口方法；其中，web应用后端虽然会对每个API做详细的类型以及参数类型定义，但名称一般不太友好，故本方案中，web应用前端会根据API接口类型再自定义接口类型，然后进行集中管理和使用，从而使前端项目结构更加缜密。

进一步地，所述web应用后端集成Swagger并生成对应的web接口文档和接口类型定义文件时具体包括以下步骤：

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