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

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

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

【技术实现步骤摘要】
一种后端接口自动文档生成的集成方法
本专利技术涉及计算机
，具体而言，涉及一种后端接口自动文档生成的集成方法。
技术介绍
随着移动互联网技术的发展，目前整个系统采用微服务架构，后端应用与后端应用、后端应用与前端应用均采用远程调用进行数据交互。各个应用通常都是不同的人员进行开发维护，他们之间通过对远程调用的接口定义进行规范性约束。当开发团队越来越庞大，在人员之间接口定义的传播成为了沟通成本很大的工作。因此，在长期的研发当中，专利技术人对如何解决远程调用接口定义在大量的不同技术工种人员之间的传递效率问题，解决不同应用采用不同展现界面的问题进行了深入的研究，提出了一种后端接口自动文档生成的集成方法，以解决上述技术问题之一。
技术实现思路
本专利技术的目的在于提供一种后端接口自动文档生成的集成方法，能够解决上述提到的至少一个技术问题。具体方案如下：根据本专利技术的具体实施方式，第一方面，一种后端接口自动文档生成的集成方法，该方法包括如下步骤，S1、以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解之中；S2、各个部门按产品、项目自动形成接口树形结构，自动在文档系统中形成记录；S3、接口法布施自动解析代码注释和注解，生成自定义的接口页面；S4、接口发布后，生成的接口展示页面自动上传至文档系统，全员可见。根据本专利技术的具体实施方式，第二方面，一种后端接口自动文档生成的集成方法，步骤S1中以注解方式规范代码注释、注解，各个接口定义人按照规范撰写注释和注解。根据本专利技术的具体实施方式，第三方面，一种后端接口自动文档生成的集成方法，所述注释和注解包括接口注释、方法注释、字段注释。根据本专利技术的具体实施方式，第四方面，一种后端接口自动文档生成的集成方法，所述方法注释用于解释本方法的具体使用说明，字段注释用于解释本字段的含义。根据本专利技术的具体实施方式，第五方面，一种后端接口自动文档生成的集成方法，所述接口注释和方法注释必须包括作者、页面标题。根据本专利技术的具体实施方式，第六方面，一种后端接口自动文档生成的集成方法，所述步骤S2中各个部门按产品、项目自动形成接口树形结构，撰写接口代码时，需要按照规范撰写，通过技术手段在接口代码发布之前，字段检测代码注释和注解，对不满足规范的接口代码不予发布。根据本专利技术的具体实施方式，第七方面，一种后端接口自动文档生成的集成方法，所述各部门撰写接口代码时，需要按照规范撰写，并通过技术手段提醒开发者不符合规范的代码位置，保证代码注释和注解能够正确地生成文档。根据本专利技术的具体实施方式，第八方面，一种后端接口自动文档生成的集成方法，所述接口发布后，生成的接口展示页面自动上传至文档系统，其中文档系统采用maven构建。根据本专利技术的具体实施方式，第九方面，一种后端接口自动文档生成的集成方法，所述接口发布时需要对接口代码进行打包，打包时将自动生成javadoc的xml格式文件。根据本专利技术的具体实施方式，第十方面，一种后端接口自动文档生成的集成方法，所述打包时自动生成的javadoc的xml格式文件通过自助程序读取并进行解析，按照规定好的格式获取各个字段的信息，生成页面树形结构，并且检查页面结构关系以及页面是否已经存在，对已经存在的页面进行更新，对不存在的页面进行创建。根据本专利技术的具体实施方式，第十一方面，本专利技术提供一种计算机可读存储介质，其上存储有计算机程序，所述程序被处理器执行时实现如上任一项所述的对文档中的内容进行编辑的方法。根据本专利技术的具体实施方式，第十二方面，本专利技术提供一种电子设备，包括：一个或多个处理器；存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现如上任一项所述的对文档中的内容进行编辑的方法。本专利技术实施例的上述方案与现有技术相比，至少具有以下有益效果：本专利技术主要解决远程调用接口定义在大量的不同技术工种人员之间的传递效率问题，解决不同应用采用不同展现界面的问题。本专利技术在上述技术方案的前提下能够提高不同技术工种人员之间信息传递的效率且能够在不同应用中或者不同应用的不同展现界面中展示相同的注解、注释，并且通过注解注释生成文档。附图说明此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本专利技术的实施例，并与说明书一起用于解释本专利技术的原理。显而易见地，下面描述中的附图仅仅是本专利技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。在附图中：图1示出了根据本专利技术实施例的方法流程图；图2示出了根据本专利技术实施例的状态示意图；图3示出了根据本专利技术的实施例的电子设备连接结构示意图。具体实施方式为了使本专利技术的目的、技术方案和优点更加清楚，下面将结合附图对本专利技术作进一步地详细描述，显然，所描述的实施例仅仅是本专利技术一部分实施例，而不是全部的实施例。基于本专利技术中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其它实施例，都属于本专利技术保护的范围。在本专利技术实施例中使用的术语是仅仅出于描述特定实施例的目的，而非旨在限制本专利技术。在本专利技术实施例和所附权利要求书中所使用的单数形式的“一种”、“所述”和“该”也旨在包括多数形式，除非上下文清楚地表示其他含义，“多种”一般包含至少两种。应当理解，本文中使用的术语“和/或”仅仅是一种描述关联对象的关联关系，表示可以存在三种关系，例如，A和/或B，可以表示：单独存在A，同时存在A和B，单独存在B这三种情况。另外，本文中字符“/”，一般表示前后关联对象是一种“或”的关系。应当理解，尽管在本专利技术实施例中可能采用术语第一、第二、第三等来描述……，但这些……不应限于这些术语。这些术语仅用来将……区分开。例如，在不脱离本专利技术实施例范围的情况下，第一……也可以被称为第二……，类似地，第二……也可以被称为第一……。取决于语境，如在此所使用的词语“如果”、“若”可以被解释成为“在……时”或“当……时”或“响应于确定”或“响应于检测”。类似地，取决于语境，短语“如果确定”或“如果检测(陈述的条件或事件)”可以被解释成为“当确定时”或“响应于确定”或“当检测(陈述的条件或事件)时”或“响应于检测(陈述的条件或事件)”。还需要说明的是，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的商品或者装置不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种商品或者装置所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的商品或者装置中还存在另外的相同要素。下面结合附图详细说明本专利技术的可选实施例。实施例1一种后端接口自动文档生成的集成方法，其中该方法包括以下的步骤：S1，以注解方式规范代码注释，将接口定义的重要信息填写在接口注释和接口注解之中S2，各个部门按产品、项目自动形成接口树形结构，自动在文档系统中形成记录。S3，接口发布时自动解析代码注释和注解，生成自定义的接口页面。S4:接口发布后，生成的接口展示页面自动上传到文档系统，全员可见。实施例2一种后端接口自动文档生成的集成方法，其中该方法包括以下的步骤：首先，定义接口代码注释规范、注解规范，各个接口定义人按照规范撰写注释和本文档来自技高网...

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

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

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