CN112230988A - 接口文档的生成方法、装置、计算机设备和存储介质 - Google Patents
接口文档的生成方法、装置、计算机设备和存储介质 Download PDFInfo
- Publication number
- CN112230988A CN112230988A CN202011110899.4A CN202011110899A CN112230988A CN 112230988 A CN112230988 A CN 112230988A CN 202011110899 A CN202011110899 A CN 202011110899A CN 112230988 A CN112230988 A CN 112230988A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- generating
- plug
- interface document
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
- 238000000034 method Methods 0.000 title claims abstract description 63
- 238000012986 modification Methods 0.000 claims abstract description 37
- 230000004048 modification Effects 0.000 claims abstract description 37
- 230000015654 memory Effects 0.000 claims description 28
- 238000011161 development Methods 0.000 claims description 14
- 239000003607 modifier Substances 0.000 claims description 8
- 230000008878 coupling Effects 0.000 abstract description 5
- 238000010168 coupling process Methods 0.000 abstract description 5
- 238000005859 coupling reaction Methods 0.000 abstract description 5
- 230000006870 function Effects 0.000 description 6
- 238000010586 diagram Methods 0.000 description 3
- 238000012423 maintenance Methods 0.000 description 3
- 230000003287 optical effect Effects 0.000 description 3
- 238000010276 construction Methods 0.000 description 2
- 238000005516 engineering process Methods 0.000 description 2
- 238000012545 processing Methods 0.000 description 2
- 238000012360 testing method Methods 0.000 description 2
- 230000006399 behavior Effects 0.000 description 1
- 230000001413 cellular effect Effects 0.000 description 1
- 238000004140 cleaning Methods 0.000 description 1
- 230000007547 defect Effects 0.000 description 1
- 238000001514 detection method Methods 0.000 description 1
- 239000004973 liquid crystal related substance Substances 0.000 description 1
- 238000004806 packaging method and process Methods 0.000 description 1
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/73—Program documentation
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/40—Transformation of program code
- G06F8/41—Compilation
- G06F8/44—Encoding
- G06F8/447—Target code generation
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
- G06F9/44—Arrangements for executing specific programs
- G06F9/445—Program loading or initiating
- G06F9/44521—Dynamic linking or loading; Link editing at or after load time, e.g. Java class loading
- G06F9/44526—Plug-ins; Add-ons
Landscapes
- Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Theoretical Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Library & Information Science (AREA)
- Document Processing Apparatus (AREA)
Abstract
本发明涉及一种接口文档的生成方法、装置、计算机设备和存储介质，所述方法包括：初始化接口代码；在项目对象模型文件中接入接口文档生成插件；在项目对象模型的配置文件中配置目标地址信息、类路径信息以及文件格式信息；采用接口文档生成插件扫描maven管理的项目源码并在项目源码中读取目标地址信息、类路径信息以及文件格式信息；根据目标地址信息以及类路径信息确定对应的目标代码接口，获取目标代码接口的接口名称、修饰符号、参数内容以及注释内容；根据文件格式信息以及目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成目标代码接口的接口文档。上述方法能够去除项目与接口文档生成装置的耦合性，降低项目风险与出现bug的几率。
Description
技术领域
本发明涉及接口处理技术领域，特别是涉及一种接口文档的生成方法、装置、计算机设备和存储介质。
背景技术
传统生成接口文档的技术中，需要引入第三方所需jar(软件包文件格式)包，并在项目中新增一个第三方的配置类，同时需要在项目中新增第三方的注解，项目启动时根据配置的注解生成相应规范的接口文档。
这种生成接口文档的方式，引入了第三方jar包，需要学习第三方项目的使用方法，增加学习的成本。同时，因需要新增第三方jar包，所以在打包部署项目时，打包出来的部署的文件较之前更大，让项目变得更加的臃肿。另外，因需要在项目代码增加第三方要求的相关配置，致使自身项目的复杂度上升，增加自身项目的复杂度。整合第三方项目到自身的项目中，存在第三方项目bug导致自身项目崩溃的风险，或第三方项目与自身项目现有代码冲突造成的未知bug，导致自身项目的风险和维护成本上升。
发明内容
本发明的目的在于克服现有技术的不足，提供了一种接口文档的生成方法、装置、计算机设备和存储介质，能够去除项目与接口文档生成装置的耦合性，以降低项目运行时的风险与可能出现bug的几率，同时不需要往项目中添加任何第三方的注解或者是配置文件，从而侧面提升了服务的性能。
为了解决上述中至少一个技术问题，本发明实施例提供了一种接口文档的生成方法，所述方法包括：
在集成开发环境IDE的编辑器中初始化接口代码；
在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；
在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；
启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；
采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；
采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
在其中一个实施例中，所述文件格式信息包括排版格式，所述根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档，包括：
按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
在其中一个实施例中，所述方法还包括：确定所述目标代码接口的接口文档的文档语言；
所述按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档，包括：
将所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为所述文档语言的接口名称、修饰符号、参数内容以及注释内容；
按照所述排版格式对所述文档语言的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
在其中一个实施例中，所述根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口之后，包括：
根据预设的接口名称定义规范判断所述目标代码接口的统一资源定位符是否符合预设要求；
若是，执行所述获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容的步骤。
在其中一个实施例中，所述在maven的项目对象模型文件中接入接口文档生成插件之前，还包括：
确定一个或多个接口的接口定义规范信息；
根据所述接口定义规范信息生成所述接口文档生成插件。
在其中一个实施例中，所述采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档之后，还包括：
若检测到采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，使用集成开发环境插件生成所述目标代码接口的接口文档。
在其中一个实施例中，所述采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，包括：
采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息生成所述目标代码接口的类和方法；
根据生成的所述目标代码接口的类和方法确定所述目标代码接口。
一种接口文档的生成装置，所述装置包括：
初始化模块，用于在编辑器中初始化接口代码；
接入模块，用于在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；
配置模块，用于在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；
读取模块，用于启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；
获取模块，用于采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；
生成模块，用于采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
另外，本发明实施例还提供了一种计算机设备，其包括：存储器、处理器及存储在存储器上并可在处理器上运行的应用程序，处理器执行应用程序时实现上述任一实施例方法的步骤。
另外，本发明实施例还提供了一种计算机可读存储介质，其上存储有应用程序，应用程序被处理器执行时实现上述任一实施例方法的步骤。
在本发明实施例中，通过实施上述方法，在开发人员完成接口代码的初始化操作之后，运行maven插件，maven插件根据提前配置好的信息寻找目标代码接口，并生成接口文档文件。整个过程对自身项目友好，不需要在自身的项目中添加额外的东西，且在生成接口文档文件时亦不需要成功运行自身的项目，只需要按照规范完成接口的初始化操作即可成功生成接口文档。因此，能够去除项目与接口文档生成装置的耦合性，以降低项目运行时的风险与可能出现bug的几率，同时不需要往项目中添加任何第三方的注解或者是配置文件，从而侧面提升了服务的性能。
附图说明
图1是本发明实施例中的一种接口文档的生成方法的流程示意图；
图2是本发明另一实施例中的一种接口文档的生成方法的流程示意图；
图3是本发明实施例中的一种接口文档的生成装置的结构示意图；
图4是本发明实施例中的计算机设备的结构组成示意图。
具体实施方式
下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其它实施例，都属于本发明保护的范围。
本发明实施例提供了一种接口文档的生成方法，如图1所示，该一种接口文档的生成方法包括以下步骤：
S102，在集成开发环境IDE的编辑器中初始化接口代码。
在本实施例中，在编辑器中完成接口代码的初始化操作。具体地，如图2所示，在集成开发环境IDE完成接口代码的初始化工作。集成开发环境(IDE，Integrated DevelopmentEnvironment)是用于提供程序开发环境的应用程序，一般包括代码编辑器、编译器、调试器和图形用户界面等工具。集成了代码编写功能、分析功能、编译功能、调试功能等一体化的开发软件服务套。所有具备这一特性的软件或者软件套都可以叫集成开发环境。因此，在集成开发环境IDE的编辑器编写接口代码，并初始化接口代码。
S104，在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件。
在本实施例中，如图2所示，在pom(Project Object Model，项目对象模型)文件中引入maven接口文档生成插件。
在一实施例中，所述在maven的项目对象模型文件中接入接口文档生成插件之前，还包括：确定一个或多个接口的接口定义规范信息；根据所述接口定义规范信息生成所述接口文档生成插件。
具体地，在编写maven插件时可以预先约定的接口定义规范来进行接口内容的读取。也即是，在利用maven插件读取目标代码接口的相关信息之前，先确定出一个或多个接口的接口定义规范信息。一个或多个接口的接口定义规范信息中包含有目标代码接口的接口定义规范信息。同时，将一个或多个接口的接口定义规范信息输入到编写的maven插件。因此，即可利用maven插件读取目标代码接口的相关信息。所以免去了开发人员的学习成本，开发人员只需要按照之前预先约定的接口定义规范进行正常的接口代码编写即可而不需要像使用其他第三方项目进行接口文档生成一样去专门学习其他第三方的使用方法，可以有效地提升开发效率。
S106，在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息。
在本实施例中，如图2所示，在项目对象模型的配置文件中配置相关信息。具体为，在pom.xml文件中配置相关信息。相关信息包括生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息。例如：生成接口文档的目标地址，需要生成接口文档的类路径，生成接口文档的文件格式等等。
S108，启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息。
在本实施例中，启动接口文档生成插件后，接口文档生成插件扫描maven管理的项目源码并在项目源码中读取目标地址信息、类路径信息以及文件格式信息。例如，启动接口文档生成插件，接口文档生成插件将会扫描以maven(是一个软件项目管理及自动构建工具)管理的java项目工程源码并在项目源码中读取上述步骤S106中配置文件的内容。
S110，采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容。
在本实施例中，接口文档生成插件根据目标地址信息以及类路径信息确定对应的目标代码接口，获取目标代码接口的接口名称、修饰符号、参数内容以及注释内容。具体地，接口文档生成插件根据配置文件信息寻找到相应的目标代码接口，之后对寻找到的目标代码接口进行接口名称、修饰符号、参数内容、注释内容进行识别，以获取对应的信息。
在一实施例中，所述根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口之后，包括：根据预设的接口名称定义规范判断所述目标代码接口的统一资源定位符是否符合预设要求；若是，执行所述获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容的步骤。
具体地，可以按照一定的接口名称定义规范检测接口url(统一资源定位符)是否符合要求。若是，最终输出接口文档到word中或者接口文档管理系统中。因此，可以精准地确定出目标代码接口。
在一实施例中，所述采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，包括：采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息生成所述目标代码接口的类和方法；根据生成的所述目标代码接口的类和方法确定所述目标代码接口。
具体地，在开发人员完成接口代码的初始化操作之后，运行maven插件，maven插件根据提前配置好的信息寻找相应的需要生成为接口的类和方法，并在指定的位置生成文档文件。整个过程对自身项目友好，不需要在自身的项目中添加额外的东西，且在生成文档文件时亦不需要成功运行自身的项目，只需要按照规范完成接口的初始化操作即可成功生成接口文档。
S112，采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
其中，maven将所有项目统一抽象成一套生命周期:项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成……几乎所有项目的构建，都能映射到这一组生命周期上。但生命周期是抽象的，maven的生命周期本身是不做任何实际工。任务执行，如编译源代码，均交由插件完成。其中每个构建步骤都可以绑定一个或多个插件的目标，而且maven为大多数构建步骤都编写并绑定了默认插件。当用户有特殊需要的时候，也可以配置插件定制构建行为，甚至编写插件。maven的特性决定了利用maven插件生成接口代码文档的方式具有更高的灵活性，可以根据需要灵活的调整相应的策略以及根据内部规范在编写插件时将一些接口的规范检查添加进去。maven插件对本身项目代码的无侵入性，因为maven插件不需要在项目原有代码中添加任何代码，这样使得项目代码尽可能的干净，有效的降低了项目在运行过程中的风险。又因为在编写maven插件时可以完全按照内部约定的接口定义规范来进行接口内容的读取，所以免去了开发人员的学习成本，开发人员只需要按照之前约定的接口规范进行正常的接口代码编写即可，而不需要像使用其他第三方项目进行接口文档生成一样去专门学习其他第三方的使用方法。
在本实施例中，接口文档生成插件根据文件格式信息以及目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成目标代码接口的接口文档。也即是，如图2所示，接口文档生成插件将S110识别出来的内容生成接口文档，从而实现接口文档的自动化生成。
在一实施例中，所述文件格式信息包括排版格式。S112包括：按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
具体地，可以利用maven插件对接口源码扫描。由maven插件按照排版格式对目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成目标代码接口的接口文档。也即是，maven插件自动生成符合规范中要求的排版格式，从而使得自动化生成的接口文档可以匹配各种排版要求。
在一实施例中，S112之前，还包括：确定所述目标代码接口的接口文档的文档语言。所述按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档，包括：将所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为所述文档语言的接口名称、修饰符号、参数内容以及注释内容；按照所述排版格式对所述文档语言的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
具体地，接口文档可以设置对应的文档语言。maven插件将目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为文档语言对应的内容后，再生成文档语言的接口文档。因此，可使得最终的接口文档更加可以自动化匹配各种文档语言需求。
在一实施例中，S112之后，还包括：若检测到采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，使用集成开发环境插件生成所述目标代码接口的接口文档。
具体地，若是采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，不能实现自动化生成接口文档，则使用集成开发环境插件生成目标代码接口的接口文档。也即是，可以利用其他插件方式进行接口文档生成。
综上，本申请在使用上简单方便，不需要在自身的项目中添加任何的第三方工具包，与自身的项目不存在耦合性。具体地，利用maven插件的无侵入性，可以有效的去除自身项目与文档生成装置的耦合性，去除了耦合性也自然而然地降低了自身项目运行时的风险与可能出现bug的几率。进一步地，不需要再往自身的项目中添加任何第三方的注解或者是配置文件，从而侧面提升了服务的性能。
再者，在开发的过程中接口文档的修改和维护是比较频繁的，如使用现有方案需要重新启动自身项目使自身项目框架重新加载上下文及配置信息，重新进行文档的生成工作，而本申请的接口文档的生成工作不涉及到自身项目的运行问题，只需要重新运行maven插件即可，相比之下现有的方案显得笨重不够灵活，而本申请则可以随时更改随时重新生成。
此外，本申请因为不需要添加额外的jar包，所以在打包发布时，用来发布的包也比原有方案的更小更轻便；如使用了原有方案进行接口文档的生成工作，项目组中的所有成员都需要去学习第三方工具的使用规范和方法，而采用本申请的话，则只需要一人完成初期配置工作，其他人在之后需要文档生成时，只需要运行插件“一键生成即可”，开发者不需要因为接口文档生成而去专门学习第三方工具的使用，节约了学习成本；使用现有方案意味着在后期的代码维护工作中需要维护该第三方工具，而本申请则没有这样的负担，因为本方案采用的自主扩展maven插件的方式是零入侵，无耦合的，大大的降低了项目的复杂度，减轻了后期项目维护过程中的负担。
本发明还提供一种接口文档的生成装置。如图3所示，一种接口文档的生成装置包括：
初始化模块12，用于在编辑器中初始化接口代码；
接入模块14，用于在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；
配置模块16，用于在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；
读取模块18，用于启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；
获取模块20，用于采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；
生成模块22，用于采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
优选地，所述文件格式信息包括排版格式，生成模块22具体还用于：按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
优选地，所述装置还包括第一确定模块，用于确定所述目标代码接口的接口文档的文档语言。生成模块22具体还用于：将所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为所述文档语言的接口名称、修饰符号、参数内容以及注释内容，按照所述排版格式对所述文档语言的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
优选地，所述装置还包括判断模块，用于根据预设的接口名称定义规范判断所述目标代码接口的统一资源定位符是否符合预设要求；若是，执行获取模块20的内容。
优选地，所述装置还包括第二确定模块，用于确定一个或多个接口的接口定义规范信息，根据所述接口定义规范信息生成所述接口文档生成插件。
优选地，所述装置还包括检测模块，用于若检测到采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，使用集成开发环境插件生成所述目标代码接口的接口文档。
优选地，获取模块20具体还用于采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息生成所述目标代码接口的类和方法；根据生成的所述目标代码接口的类和方法确定所述目标代码接口。
关于一种接口文档的生成装置的具体限定可以参见上文中对于一种接口文档的生成方法的限定，在此不再赘述。上述一种接口文档的生成装置中的各个模块可全部或部分通过软件、硬件及其组合来实现。上述各模块可以硬件形式内嵌于或独立于计算机设备中的处理器中，也可以以软件形式存储于计算机设备中的存储器中，以便于处理器调用执行以上各个模块对应的操作。
本发明实施例提供的一种计算机可读存储介质，所述计算机可读存储介质上存储有应用程序，该程序被处理器执行时实现上述实施例中任意一个实施例的一种接口文档的生成方法。其中，所述计算机可读存储介质包括但不限于任何类型的盘(包括软盘、硬盘、光盘、CD-ROM、和磁光盘)、ROM(Read-Only Memory，只读存储器)、RAM(Random AcceSSMemory，随即存储器)、EPROM(EraSable Programmable Read-Only Memory，可擦写可编程只读存储器)、EEPROM(Electrically EraSable ProgrammableRead-Only Memory，电可擦可编程只读存储器)、闪存、磁性卡片或光线卡片。也就是，存储设备包括由设备(例如，计算机、手机)以能够读的形式存储或传输信息的任何介质，可以是只读存储器，磁盘或光盘等。
本发明实施例还提供了一种计算机应用程序，其运行在计算机上，该计算机应用程序用于执行上述中任意一个实施例的一种接口文档的生成方法。
此外，图4是本发明实施例中的计算机设备的结构组成示意图。
本发明实施例还提供了一种计算机设备，如图4所示。所述计算机设备包括处理器402、存储器403、输入单元404以及显示单元405等器件。本领域技术人员可以理解，图4示出的设备结构器件并不构成对所有设备的限定，可以包括比图示更多或更少的部件，或者组合某些部件。存储器403可用于存储应用程序401以及各功能模块，处理器402运行存储在存储器403的应用程序401，从而执行设备的各种功能应用以及数据处理。存储器可以是内存储器或外存储器，或者包括内存储器和外存储器两者。内存储器可以包括只读存储器(ROM)、可编程ROM(PROM)、电可编程ROM(EPROM)、电可擦写可编程ROM(EEPROM)、快闪存储器、或者随机存储器。外存储器可以包括硬盘、软盘、ZIP盘、U盘、磁带等。本发明所公开的存储器包括但不限于这些类型的存储器。本发明所公开的存储器只作为例子而非作为限定。
输入单元404用于接收信号的输入，以及接收用户输入的关键字。输入单元404可包括触控面板以及其它输入设备。触控面板可收集用户在其上或附近的触摸操作(比如用户使用手指、触笔等任何适合的物体或附件在触控面板上或在触控面板附近的操作)，并根据预先设定的程序驱动相应的连接装置；其它输入设备可以包括但不限于物理键盘、功能键(比如播放控制按键、开关按键等)、轨迹球、鼠标、操作杆等中的一种或多种。显示单元405可用于显示用户输入的信息或提供给用户的信息以及终端设备的各种菜单。显示单元405可采用液晶显示器、有机发光二极管等形式。处理器402是终端设备的控制中心，利用各种接口和线路连接整个设备的各个部分，通过运行或执行存储在存储器403内的软件程序和/或模块，以及调用存储在存储器内的数据，执行各种功能和处理数据。
作为一个实施例，所述计算机设备包括：一个或多个处理器402，存储器403，一个或多个应用程序401，其中所述一个或多个应用程序401被存储在存储器403中并被配置为由所述一个或多个处理器402执行，所述一个或多个应用程序401配置用于执行上述实施例中的任意一实施例中的一种接口文档的生成方法。
另外，以上对本发明实施例所提供的一种接口文档的生成方法、装置、计算机设备和存储介质进行了详细介绍，本文中应采用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。
Claims (10)
1.一种接口文档的生成方法，其特征在于，所述方法包括：
在集成开发环境IDE的编辑器中初始化接口代码；
在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；
在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；
启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；
采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；
采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
2.根据权利要求1所述的方法，其特征在于，所述文件格式信息包括排版格式，所述根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档，包括：
按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
3.根据权利要求2所述的方法，其特征在于，所述方法还包括：确定所述目标代码接口的接口文档的文档语言；
所述按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档，包括：
将所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为所述文档语言的接口名称、修饰符号、参数内容以及注释内容；
按照所述排版格式对所述文档语言的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。
4.根据权利要求1所述的方法，其特征在于，所述根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口之后，包括：
根据预设的接口名称定义规范判断所述目标代码接口的统一资源定位符是否符合预设要求；
若是，执行所述获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容的步骤。
5.根据权利要求1所述的方法，其特征在于，所述在maven的项目对象模型文件中接入接口文档生成插件之前，还包括：
确定一个或多个接口的接口定义规范信息；
根据所述接口定义规范信息生成所述接口文档生成插件。
6.根据权利要求1所述的方法，其特征在于，所述采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档之后，还包括：
若检测到采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，使用集成开发环境插件生成所述目标代码接口的接口文档。
7.根据权利要求1所述的方法，其特征在于，所述采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，包括：
采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息生成所述目标代码接口的类和方法；
根据生成的所述目标代码接口的类和方法确定所述目标代码接口。
8.一种接口文档的生成装置，其特征在于，所述装置包括：
初始化模块，用于在编辑器中初始化接口代码；
接入模块，用于在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；
配置模块，用于在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；
读取模块，用于启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；
获取模块，用于采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；
生成模块，用于采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。
9.一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的应用程序，其特征在于，所述处理器执行所述应用程序时实现权利要求1至7中任一项所述方法的步骤。
10.一种计算机可读存储介质，其上存储有应用程序，其特征在于，所述应用程序被处理器执行时实现权利要求1至7中任一项所述方法的步骤。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202011110899.4A CN112230988A (zh) | 2020-10-16 | 2020-10-16 | 接口文档的生成方法、装置、计算机设备和存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202011110899.4A CN112230988A (zh) | 2020-10-16 | 2020-10-16 | 接口文档的生成方法、装置、计算机设备和存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN112230988A true CN112230988A (zh) | 2021-01-15 |
Family
ID=74117717
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202011110899.4A Pending CN112230988A (zh) | 2020-10-16 | 2020-10-16 | 接口文档的生成方法、装置、计算机设备和存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN112230988A (zh) |
Cited By (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN112783551A (zh) * | 2021-01-21 | 2021-05-11 | 中信银行股份有限公司 | 微服务框架的接口文档生成方法、电子设备及存储介质 |
| CN113031925A (zh) * | 2021-03-25 | 2021-06-25 | 重庆中科云从科技有限公司 | 一种接口文档生成方法、装置、机器可读介质及设备 |
| CN113791819A (zh) * | 2021-03-05 | 2021-12-14 | 京东安联财产保险有限公司 | 接口文档生成方法和装置、存储介质、电子设备 |
| CN113900706A (zh) * | 2021-10-13 | 2022-01-07 | 中国银行股份有限公司 | 接口文档的生成方法及装置 |
| CN114443129A (zh) * | 2021-12-30 | 2022-05-06 | 广东南方新媒体科技有限公司 | 一种项目文档自动化生成方法、设备及存储介质 |
Citations (6)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN107463376A (zh) * | 2017-07-21 | 2017-12-12 | 珠海牛角科技有限公司 | 基于Javadoc的自动生成后端接口文档的方法及装置 |
| US20190037005A1 (en) * | 2017-07-28 | 2019-01-31 | Kong Inc. | Auto-documentation for application program interfaces based on network requests and responses |
| CN110308900A (zh) * | 2019-06-27 | 2019-10-08 | 广州华多网络科技有限公司 | 页面路由文档的生成方法、装置、计算机设备及存储介质 |
| CN110333850A (zh) * | 2019-05-30 | 2019-10-15 | 重庆金融资产交易所有限责任公司 | 接口文档的生成方法、装置、计算机设备和存储介质 |
| CN111258563A (zh) * | 2020-01-16 | 2020-06-09 | 江苏满运软件科技有限公司 | 一种接口文档的生成方法、装置、存储介质及电子设备 |
| CN111414193A (zh) * | 2020-02-26 | 2020-07-14 | 平安银行股份有限公司 | 基于微服务框架的业务系统的实现方法及相关装置 |
-
2020
- 2020-10-16 CN CN202011110899.4A patent/CN112230988A/zh active Pending
Patent Citations (6)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN107463376A (zh) * | 2017-07-21 | 2017-12-12 | 珠海牛角科技有限公司 | 基于Javadoc的自动生成后端接口文档的方法及装置 |
| US20190037005A1 (en) * | 2017-07-28 | 2019-01-31 | Kong Inc. | Auto-documentation for application program interfaces based on network requests and responses |
| CN110333850A (zh) * | 2019-05-30 | 2019-10-15 | 重庆金融资产交易所有限责任公司 | 接口文档的生成方法、装置、计算机设备和存储介质 |
| CN110308900A (zh) * | 2019-06-27 | 2019-10-08 | 广州华多网络科技有限公司 | 页面路由文档的生成方法、装置、计算机设备及存储介质 |
| CN111258563A (zh) * | 2020-01-16 | 2020-06-09 | 江苏满运软件科技有限公司 | 一种接口文档的生成方法、装置、存储介质及电子设备 |
| CN111414193A (zh) * | 2020-02-26 | 2020-07-14 | 平安银行股份有限公司 | 基于微服务框架的业务系统的实现方法及相关装置 |
Non-Patent Citations (1)
| Title |
|---|
| 名扬天下: "Java Web接口文档——smart-doc", pages 1 - 5, Retrieved from the Internet <URL:https://www.cnblogs.com/qinxiaofei/p/13723679.html> * |
Cited By (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN112783551A (zh) * | 2021-01-21 | 2021-05-11 | 中信银行股份有限公司 | 微服务框架的接口文档生成方法、电子设备及存储介质 |
| CN113791819A (zh) * | 2021-03-05 | 2021-12-14 | 京东安联财产保险有限公司 | 接口文档生成方法和装置、存储介质、电子设备 |
| CN113031925A (zh) * | 2021-03-25 | 2021-06-25 | 重庆中科云从科技有限公司 | 一种接口文档生成方法、装置、机器可读介质及设备 |
| CN113900706A (zh) * | 2021-10-13 | 2022-01-07 | 中国银行股份有限公司 | 接口文档的生成方法及装置 |
| CN114443129A (zh) * | 2021-12-30 | 2022-05-06 | 广东南方新媒体科技有限公司 | 一种项目文档自动化生成方法、设备及存储介质 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN112230988A (zh) | 接口文档的生成方法、装置、计算机设备和存储介质 | |
| US10409574B2 (en) | Incremental whole program compilation of code | |
| US7975257B2 (en) | Iterative static and dynamic software analysis | |
| US10261889B2 (en) | Techniques for edit-and-continue and enhanced optimized debugging on optimized code | |
| US9298427B2 (en) | Creating inferred symbols from code usage | |
| CN101930400B (zh) | Sdk自动化测试系统及方法 | |
| US10331425B2 (en) | Automated source code adaption to inject features between platform versions | |
| CN107526625B (zh) | 一种基于字节码检查的Java智能合约安全检测方法 | |
| KR102184436B1 (ko) | 저스트 마이 코드를 이용하는 자바스크립트 디버깅 기법 | |
| Li et al. | Program tailoring: Slicing by sequential criteria | |
| Toman et al. | Taming the static analysis beast | |
| US20150067653A1 (en) | Automatic generation of analysis-equivalent application constructs | |
| US20180129494A1 (en) | Detect application defects by correlating contracts in application dependencies | |
| CN112230904A (zh) | 基于接口文档的代码生成方法、装置、存储介质及服务器 | |
| Bocic et al. | Symbolic model extraction for web application verification | |
| CN115344268A (zh) | 一种多平台嵌入式开发环境编译方法及装置 | |
| CN111796832B (zh) | 热补丁文件生成方法、装置、设备及存储介质 | |
| KR101476536B1 (ko) | 프로그램 검수 방법 및 시스템 | |
| WO2007087075A1 (en) | Compile-time interpretable code error detection | |
| Entrup et al. | ARA: Automatic Instance-Level Analysis in Real-Time Systems | |
| Rayhan et al. | Model-Based Testing of IoT Mobile Controller Smart Light Systems Using Extended Finite State Machine | |
| Dixon et al. | Using Binary Analysis Frameworks: The Case for BAP and angr | |
| CN112835565A (zh) | 一种生成组件配置器的方法、设备和存储介质 | |
| CN118708287A (zh) | 虚拟机断点调试方法、系统、设备及计算机可读存储介质 | |
| Arora | JShrink: Debloating Modern Java Applications |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |