一种后端接口自动文档生成的集成方法与流程

本发明涉及计算机技术领域，具体而言，涉及一种后端接口自动文档生成的集成方法。

背景技术：

随着移动互联网技术的发展，目前整个系统采用微服务架构，后端应用与后端应用、后端应用与前端应用均采用远程调用进行数据交互。各个应用通常都是不同的人员进行开发维护，他们之间通过对远程调用的接口定义进行规范性约束。当开发团队越来越庞大，在人员之间接口定义的传播成为了沟通成本很大的工作。

因此，在长期的研发当中，发明人对如何解决远程调用接口定义在大量的不同技术工种人员之间的传递效率问题，解决不同应用采用不同展现界面的问题进行了深入的研究，提出了一种后端接口自动文档生成的集成方法，以解决上述技术问题之一。

技术实现要素：

本发明的目的在于提供一种后端接口自动文档生成的集成方法，能够解决上述提到的至少一个技术问题。具体方案如下：

根据本发明的具体实施方式，第一方面，一种后端接口自动文档生成的集成方法，该方法包括如下步骤，

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

一种后端接口自动文档生成的集成方法，其中该方法包括以下的步骤：

首先，定义接口代码注释规范、注解规范，各个接口定义人按照规范撰写注释和注解。具体是规定了接口注释、方法注释、字段注释，接口注释解释本接口的主要功能集，方法注释解释本方法的具体使用说明，字段注释解释本字段的含义。接口注释和方法注释必须包含作者、页面标题。字段可用@notnull或@notempty注解，标示其不可为空，文档中将会展示出此信息。

接下来，各部门撰写接口代码时，需按照规范撰写；通过技术手段在接口代码发布之前，字段检测代码注释和注解，对不满足规范的接口代码不予发布，同时提醒开发者不符合规范的代码位置，保证代码注释和注解能正确地生成文档。

最后，解析接口代码注释和注解，生成文档页面，上传到文档系统；项目必须是maven构建，接口代码打包时将自动生成javadoc的xml格式文件，自助程序读取并解析该xml文件，按规定好的格式获取各个字段信息；生成页面树形结构；检查页面结构关系以及页面是否已存在，对已存在的页面做更新，对不存在的页面做创建。

实施例3

一种后端接口自动文档生成的集成方法，其中采用maven构建的项目，项目配置maven-javadoc-plugin如下：<plugin>

实施例4

如图3所示，本实施例提供一种电子设备，该设备用于后端接口自动文档生成的集成方法，所述电子设备，包括：至少一个处理器；以及，与所述至少一个处理器通信连接的存储器；其中所述存储器存储有可被所述一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够通过调用上述存储器中存储的一个或多个指令或指令集、可执行程序等实现上述的方法。

实施例5

本公开实施例提供了一种非易失性计算机存储介质，所述计算机存储介质存储有计算机可执行指令，该计算机可执行指令可执行上述任意方法实施例中的后端接口自动文档生成的集成方法。

如图3所示，其示出了适于用来实现本公开实施例的电子设备400的结构示意图。本公开实施例中的终端设备可以包括但不限于诸如移动电话、笔记本电脑、数字广播接收器、pda(个人数字助理)、pad(平板电脑)、pmp(便携式多媒体播放器)、车载终端(例如车载导航终端)等等的移动终端以及诸如数字tv、台式计算机等等的固定终端。电子设备仅仅是一个示例，不应对本公开实施例的功能和使用范围带来任何限制。

如图3所示，电子设备400可以包括处理装置(例如中央处理器、图形处理器等)401，其可以根据存储在只读存储器(rom)402中的程序或者从存储装置408加载到随机访问存储器(ram)403中的程序而执行各种适当的动作和处理。在ram403中，还存储有电子设备400操作所需的各种程序和数据。处理装置401、rom402以及ram403通过总线404彼此相连。输入/输出(i/o)接口405也连接至总线404。

通常，以下装置可以连接至i/o接口405：包括例如触摸屏、触摸板、键盘、鼠标、摄像头、麦克风、加速度计、陀螺仪等的输入装置406；包括例如液晶显示器(lcd)、扬声器、振动器等的输出装置407；包括例如磁带、硬盘等的存储装置408；以及通信装置409。通信装置409可以允许电子设备400与其他设备进行无线或有线通信以交换数据。虽然图3示出了具有各种装置的电子设备400，但是应理解的是，并不要求实施或具备所有示出的装置。可以替代地实施或具备更多或更少的装置。

特别地，根据本公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信装置409从网络上被下载和安装，或者从存储装置408被安装，或者从rom402被安装。在该计算机程序被处理装置401执行时，执行本公开实施例的方法中限定的上述功能。

需要说明的是，本公开上述的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(ram)、只读存储器(rom)、可擦式可编程只读存储器(eprom或闪存)、光纤、便携式紧凑磁盘只读存储器(cd-rom)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开中，计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：电线、光缆、rf(射频)等等，或者上述的任意合适的组合。

上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。

上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被该电子设备执行时，使得该电子设备：获取至少两个网际协议地址；向节点评价设备发送包括所述至少两个网际协议地址的节点评价请求，其中，所述节点评价设备从所述至少两个网际协议地址中，选取网际协议地址并返回；接收所述节点评价设备返回的网际协议地址；其中，所获取的网际协议地址指示内容分发网络中的边缘节点。

或者，上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被该电子设备执行时，使得该电子设备：接收包括至少两个网际协议地址的节点评价请求；从所述至少两个网际协议地址中，选取网际协议地址；返回选取出的网际协议地址；其中，接收到的网际协议地址指示内容分发网络中的边缘节点。

可以以一种或多种程序设计语言或其组合来编写用于执行本公开的操作的计算机程序代码，上述程序设计语言包括面向对象的程序设计语言—诸如java、smalltalk、c++，还包括常规的过程式程序设计语言—诸如“c”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(lan)或广域网(wan)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本公开实施例中所涉及到的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。其中，单元的名称在某种情况下并不构成对该单元本身的限定。

也就是说，在本申请所述的后端接口自动文档生成的集成方法，其能够通过现有的计算机可识别的编程语言进行代码的编写与封装，进而能够以可执行程序或指令或指令集的方式实现上述如图1至图2所示的流程图。进而在上述通过计算机可识别的编程语言进行代码编写与封装的可执行程序或指令或指令集，其存放于非易失性存储介质上，并且该存储介质能够被上述段落中任意一个段落所叙述的电子设备或电子设备构成的系统所识别与执行，该识别与执行的步骤和方法以及原理均属于如图1至图2所示出的方法或者流程。