一种后端接口自动文档生成的集成方法技术

本发明专利技术提供了一种后端接口自动文档生成的集成方法。本发明专利技术通过以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解至中，各个部门按照产品、项目自动形成接口结构，自动在文档系统中形成记录，并且在接口发布时自动解析代码注释和注解，生成自定义的接口页面，接口发布后，生成的接口展示页面自动上传到文档系统，全员可见。本发明专利技术主要解决远程调用接口定义在大量的不同技术工种人员之间的传递效率问题，解决不同应用采用不同展示军界面的问题。

An integrated method for automatic document generation of back-end interface

【技术实现步骤摘要】
一种后端接口自动文档生成的集成方法
本专利技术涉及计算机
，具体而言，涉及一种后端接口自动文档生成的集成方法。
技术介绍
随着移动互联网技术的发展，目前整个系统采用微服务架构，后端应用与后端应用、后端应用与前端应用均采用远程调用进行数据交互。各个应用通常都是不同的人员进行开发维护，他们之间通过对远程调用的接口定义进行规范性约束。当开发团队越来越庞大，在人员之间接口定义的传播成为了沟通成本很大的工作。因此，在长期的研发当中，专利技术人对如何解决远程调用接口定义在大量的不同技术工种人员之间的传递效率问题，解决不同应用采用不同展现界面的问题进行了深入的研究，提出了一种后端接口自动文档生成的集成方法，以解决上述技术问题之一。
技术实现思路
本专利技术的目的在于提供一种后端接口自动文档生成的集成方法，能够解决上述提到的至少一个技术问题。具体方案如下：根据本专利技术的具体实施方式，第一方面，一种后端接口自动文档生成的集成方法，该方法包括如下步骤，S1、以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解之中；S2、各个部门按产品、项目自动形成接口树形结构，自动在文档系统中形成记本文档来自技高网...

【技术保护点】
1.一种后端接口自动文档生成的集成方法，其特征在于，该方法包括如下步骤，S1、以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解之中；S2、各个部门按产品、项目自动形成接口树形结构，自动在文档系统中形成记录；S3、接口法布施自动解析代码注释和注解，生成自定义的接口页面；S4、接口发布后，生成的接口展示页面自动上传至文档系统，全员可见。

【技术特征摘要】
1.一种后端接口自动文档生成的集成方法，其特征在于，该方法包括如下步骤，S1、以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解之中；S2、各个部门按产品、项目自动形成接口树形结构，自动在文档系统中形成记录；S3、接口法布施自动解析代码注释和注解，生成自定义的接口页面；S4、接口发布后，生成的接口展示页面自动上传至文档系统，全员可见。2.根据权利要求1所述的后端接口自动文档生成的集成方法，其特征在于，步骤S1中以注解方式规范代码注释、注解，各个接口定义人按照规范撰写注释和注解。3.根据权利要求2所述的后端接口自动文档生成的集成方法，其特征在于，所述注释和注解包括接口注释、方法注释、字段注释。4.根据权利要求3所述的后端接口自动文档生成的集成方法，其特征在于，所述方法注释用于解释本方法的具体使用说明，字段注释用于解释本字段的含义。5.根据权利要求4所述的后端接口自动文档生成的集成方法，其特征在于，所述接口注释和方法注释必须包括作者、页面标题。6.根据权利要求1所述的后端接口自动文档生成的集成方法，其特征在于，所述步骤S2中各个...

【专利技术属性】
技术研发人员：蔡灿，
申请(专利权)人：重庆天蓬网络有限公司，
类型：发明
国别省市：重庆,50