CN111399900B - 一种基于python与正则表达式的API文档自动生成方法及系统 - Google Patents

一种基于python与正则表达式的API文档自动生成方法及系统 Download PDF

Info

Publication number
CN111399900B
CN111399900B CN202010161235.4A CN202010161235A CN111399900B CN 111399900 B CN111399900 B CN 111399900B CN 202010161235 A CN202010161235 A CN 202010161235A CN 111399900 B CN111399900 B CN 111399900B
Authority
CN
China
Prior art keywords
api
document
file
api document
template
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.)
Active
Application number
CN202010161235.4A
Other languages
English (en)
Other versions
CN111399900A (zh
Inventor
姜昱鹏
徐士强
宋亚萍
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
Shandong Huimao Electronic Port Co Ltd
Original Assignee
Shandong Huimao Electronic Port Co Ltd
Priority date (The priority date 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 date listed.)
Filing date
Publication date
Application filed by Shandong Huimao Electronic Port Co Ltd filed Critical Shandong Huimao Electronic Port Co Ltd
Priority to CN202010161235.4A priority Critical patent/CN111399900B/zh
Publication of CN111399900A publication Critical patent/CN111399900A/zh
Application granted granted Critical
Publication of CN111399900B publication Critical patent/CN111399900B/zh
Active legal-status Critical Current
Anticipated expiration legal-status Critical

Links

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
    • Y—GENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS
    • Y02—TECHNOLOGIES OR APPLICATIONS FOR MITIGATION OR ADAPTATION AGAINST CLIMATE CHANGE
    • Y02D—CLIMATE CHANGE MITIGATION TECHNOLOGIES IN INFORMATION AND COMMUNICATION TECHNOLOGIES [ICT], I.E. INFORMATION AND COMMUNICATION TECHNOLOGIES AIMING AT THE REDUCTION OF THEIR OWN ENERGY USE
    • Y02D10/00—Energy efficient computing, e.g. low power processors, power management or thermal management

Landscapes

  • Engineering & Computer Science (AREA)
  • Software Systems (AREA)
  • General Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • Library & Information Science (AREA)
  • Physics & Mathematics (AREA)
  • General Physics & Mathematics (AREA)
  • Document Processing Apparatus (AREA)

Abstract

本发明公开了一种基于python与正则表达式的API文档自动生成方法及系统，属于python正则表达式文本匹配技术领域，本发明要解决的技术问题为如何利用可匹配属性和不可匹配属性自动生成API文档，实现后端项目开发完成后编写大规模API文档省时省力，减少大量不必要的重复工作，采用的技术方案为：该方法是通过识别匹配概览文件中的可匹配属性值，填充API模块，自动生成API文档，文档中可匹配属性及值已自动生成，不可匹配属性自动生成值为空，值留待人工填充。该系统包括概览文件建立模块、API模板建立模块和识别匹配模块。

Description

一种基于python与正则表达式的API文档自动生成方法及系统
技术领域
本发明涉及python正则表达式文本匹配技术领域，具体地说是一种基于python与正则表达式的API文档自动生成方法及系统。
背景技术
后端项目在开发完成后，需要为接口编写API文档说明，方便API调用者查阅。不同企业或个人有不同的文档编写方式，可以使用showdoc网站编写，也可以直接编写成markdown文件放置git远程仓库中。可是无论哪种方式，当项目API数量很多时，编写API文档都是件非常耗时耗力的问题。
API文档存在一个共同特点：每条API都会存在API标题、API URL、API描述、API请求方式、请求参数、响应参数、请求示例、响应示例等共同属性，只是属性值不同。这些共同属性中，API标题、API URL、API描述、API请求方式都是可被正则表达式方便匹配的文本形式，称为可匹配属性；请求参数、响应参数属性一般情况下是表格的形式，示例等属性一般是json格式，这些属性内容复杂无规律，可匹配性不高，称为不可匹配属性。将可匹配属性值统一放置于概览文件中。故如何利用可匹配属性和不可匹配属性自动生成API文档，实现后端项目开发完成后编写大规模API文档省时省力，减少大量不必要的重复工作是目前现有技术中亟待解决的问题。
专利号为CN107133079B的专利文献公开了一种基于问题报告的软件语义摘要自动生成方法，先构建开源软件信息数据库；然后获取项目托管社区中的问题报告数据和代码变更记录数据，并将之存储在数据库的问题报告数据表和代码变更记录数据表中；再使用正则表达式从代码变更记录中抽取其出现的问题报告id；然后对问题报告与软件代码进行位置匹配，最后进行语义提取与聚类，将生成的语义摘要存储在数据库的软件语义摘要数据表中。该技术方案通过软件的问题报告和代码变更记录为软件的代码文件或代码段自动标注语义信息，可提高开发人员复用软件的效率，但是未能解决后端项目开发完成后编写大规模API文档耗时耗力的问题。
专利号为CN107193570A的专利文献公开了一种自动生成API文档的方法，包括：对原始后台代码执行附加apidoc注释的处理，得到附加apidoc注释的后台代码；对后台代码利用apidoc工具生成对应的API文档；当后台代码被修改时，相应的修改所述apidoc注释，得到最新版后台代码；将最新版后台代码合并进git库，并根据预设脚本调用预设命令生成最新版API文档。该技术方案能够以更加合理、更加及时的生成API文档的方法来消除因重复修改出现的遗漏生成最新版API文档的潜在隐患、提升后台与前端工程师之间的工作效率，但是未能解决后端项目开发完成后编写大规模API文档耗时耗力的问题。
发明内容
本发明的技术任务是提供一种基于python与正则表达式的API文档自动生成方法及系统，来解决如何利用可匹配属性和不可匹配属性自动生成API文档，实现后端项目开发完成后编写大规模API文档省时省力，减少大量不必要的重复工作的问题。
本发明的技术任务是按以下方式实现的，一种基于python与正则表达式的API文档自动生成方法，该方法是通过识别匹配概览文件中的可匹配属性值，填充API模块，自动生成API文档，文档中可匹配属性及值已自动生成，不可匹配属性自动生成值为空，值留待人工填充；具体如下：
S1、准备概览文件，写入可匹配属性值；
S2、准备API模板，对应概览文件的可匹配属性值，在可匹配属性位置放置python占位符，留待填充；
S3、通过识别匹配模块打开概览文件，读取并匹配一行数据，放置内存中；
S4、识别匹配模块将内存中数据填充API模板，将该条API详情放入内存中；
S5、判断API文档文件是否存在：
①、若不存在，则新建；
②、若存在，则将步骤S4内存中的填充好的API详情写入API文档中；
S6、重复步骤S3到步骤S5的操作直到概览文件数据读取完成，即生成API文档。
作为优选，所述步骤S6中生成API文档包括生成全部API文档和生成部分API文档。
作为优选，所述概览文件为API文档的目录概览，概览文件中包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅。
更优地，所述概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
作为优选，所述API模板用于定义API的公共格式，使用python占位符放置于API可匹配的属性值位置，填充匹配数据；其中，API模板能够自由定义，提高了API文档格式的丰富性。
作为优选，所述识别匹配模块由python语言编写，核心内容为正则表达式；识别匹配模块的工作过程具体如下：
(1)、识别匹配模块打开准备好的概览文件；
(2)、识别匹配模块读取并识别匹配每条API的属性值放入内存；
(3)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(4)、循环重复步骤(1)到步骤(3)，直到概览文件读取完成，即输出完整的API文档。
更优地，所述生成部分API文档的具体步骤如下：
(一)、将概览文件中所需部分的API属性值复制到系统剪切板；
(二)、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
(三)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(四)、循环重复步骤(一)到步骤(三)，直到概览文件读取完成，即输出生成部分API文档，即可该方式提供了API文档生成的多种需求。
一种基于python与正则表达式的API文档自动生成系统，该系统包括，
概览文件建立模块，用于建立API文档的目录概览文件，概览文件包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅；
API模板建立模块，用于定义API的公共格式，使用python占位符放置于API可匹配属性值位置，填充匹配数据；
识别匹配模块，用于识别概览文件并匹配属性值，再循环填充API模板生成API文档文件。
作为优选，所述概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
更优地，所述生成API文档文件包括生成全部API文档文件和生成部分API文档文件；
所述生成全部API文档文件的工作过程具体如下：
(1)、识别匹配模块打开准备好的概览文件；
(2)、识别匹配模块读取并识别匹配每条API的属性值放入内存；
(3)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(4)、循环重复步骤(1)到步骤(3)，直到概览文件读取完成，即输出完整的API文档文件。
所述生成部分API文档文件的工作过程具体如下：
(一)、将概览文件中所需部分的API属性值复制到系统剪切板；
(二)、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
(三)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(四)、循环重复步骤(一)到步骤(三)，直到概览文件读取完成，即输出生成部分API文档文件，即可该方式提供了API文档生成的多种需求。
本发明的基于python与正则表达式的API文档自动生成方法及系统具有以下优点：
(一)本发明解决了后端项目开发完成后编写大规模API文档耗时耗力的问题，通过识别匹配概览文件中的可匹配属性值，填充事先准备好的API模板，自动生成API文档，文档中可匹配属性及值已自动生成，不可匹配属性自动生成，值为空，留待人工填充，自动化生成API文档，节省大量重复性工作，省时省力；
(二)当项目API接口数量过多时，本发明解决编写API文档需进行大量重复性工作的问题，省时省力；
(三)API模板格式可自由定义，提高了API文档格式的丰富度；
(四)本发明能够生成全部API文档和部分API文档，生成部分API文档时，复制概览文件所需部分的API属性值到系统剪贴板，通过在命令行输入不同命令，生成所选部分的API文档，实现API文档的按需生成，操作灵活方便，同时即可该方式提供了API文档生成的多种需求；
(五)概览文件可以是markdown格式，提供可匹配属性值的同时，还可以通过链接跳转到API文档的详情内容，方便API查阅；也可以是文本格式，只能提供可匹配属性值，无法通过链接跳转到API文档页。
附图说明
下面结合附图对本发明进一步说明。
附图1为基于python与正则表达式的API文档自动生成方法的流程框图；
附图2为API模板的结构图；
附图3为识别匹配模块工作的流程框图，
具体实施方式
参照说明书附图和具体实施例对本发明的一种基于python与正则表达式的API文档自动生成方法及系统作以下详细地说明。
实施例1：
如附图1所示，本发明的基于python与正则表达式的API文档自动生成方法,该方法是通过识别匹配概览文件中的可匹配属性值，填充API模块，自动生成API文档，文档中可匹配属性及值已自动生成，不可匹配属性自动生成值为空，值留待人工填充；具体如下：
S1、准备概览文件，写入可匹配属性值；
S2、准备API模板，对应概览文件的可匹配属性值，在可匹配属性位置放置python占位符，留待填充；
S3、通过识别匹配模块打开概览文件，读取并匹配一行数据，放置内存中；
S4、识别匹配模块将内存中数据填充API模板，将该条API详情放入内存中；
S5、判断API文档文件是否存在：
①、若不存在，则新建；
②、若存在，则将步骤S4内存中的填充好的API详情写入API文档中；
S6、重复步骤S3到步骤S5的操作直到概览文件数据读取完成，即生成API文档。
其中，步骤S6中生成API文档包括生成全部API文档和生成部分API文档。生成部分API文档的具体步骤如下：
(一)、将概览文件中所需部分的API属性值复制到系统剪切板；
(二)、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
(三)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(四)、循环重复步骤(一)到步骤(三)，直到概览文件读取完成，即输出生成部分API文档，即可该方式提供了API文档生成的多种需求。
概览文件为API文档的目录概览，概览文件中包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅。概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
如附图2所示，API模板用于定义API的公共格式，使用python占位符放置于API可匹配的属性值位置，填充匹配数据；其中，API模板能够自由定义，提高了API文档格式的丰富性。
如附图3所示，识别匹配模块由python语言编写，核心内容为正则表达式；识别匹配模块的工作过程具体如下：
(1)、识别匹配模块打开准备好的概览文件；
(2)、识别匹配模块读取并识别匹配每条API的属性值放入内存；
(3)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(4)、循环重复步骤(1)到步骤(3)，直到概览文件读取完成，即输出完整的API文档。
实施例2：
如附图1所示，本发明的基于python与正则表达式的API文档自动生成系统，该系统包括，
概览文件建立模块，用于建立API文档的目录概览文件，概览文件包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅；概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
API模板建立模块，用于定义API的公共格式，使用python占位符放置于API可匹配属性值位置，填充匹配数据；
识别匹配模块，用于识别概览文件并匹配属性值，再循环填充API模板生成API文档文件。生成API文档文件包括生成全部API文档文件和生成部分API文档文件；
生成全部API文档文件的工作过程具体如下：
(1)、识别匹配模块打开准备好的概览文件；
(2)、识别匹配模块读取并识别匹配每条API的属性值放入内存；
(3)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(4)、循环重复步骤(1)到步骤(3)，直到概览文件读取完成，即输出完整的API文档文件。
生成部分API文档文件的工作过程具体如下：
(一)、将概览文件中所需部分的API属性值复制到系统剪切板；
(二)、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
(三)、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
(四)、循环重复步骤(一)到步骤(三)，直到概览文件读取完成，即输出生成部分API文档文件，即可该方式提供了API文档生成的多种需求。
最后应说明的是：以上各实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述各实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分或者全部技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的范围。

Claims (6)

1.一种基于python与正则表达式的API文档自动生成方法，其特征在于，该方法是通过识别匹配概览文件中的可匹配属性值，填充API模块，自动生成API文档，文档中可匹配属性及值已自动生成，不可匹配属性自动生成值为空，值留待人工填充；具体如下：
S1、准备概览文件，写入可匹配属性值；
S2、准备API模板，对应概览文件的可匹配属性值，在可匹配属性位置放置python占位符，留待填充；
S3、通过识别匹配模块打开概览文件，读取并匹配一行数据，放置内存中；
S4、识别匹配模块将内存中数据填充API模板，将该条API详情放入内存中；
S5、判断API文档文件是否存在：
①、若不存在，则新建；
②、若存在，则将步骤S4内存中的填充好的API详情写入API文档中；
S6、重复步骤S3到步骤S5的操作直到概览文件数据读取完成，即生成API文档；其中，生成API文档包括生成全部API文档和生成部分API文档；
其中，识别匹配模块由python语言编写，核心内容为正则表达式；识别匹配模块的工作过程具体如下：
（1）、识别匹配模块打开准备好的概览文件；
（2）、识别匹配模块读取并识别匹配每条API的属性值放入内存；
（3）、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
（4）、循环重复步骤（1）到步骤（3），直到概览文件读取完成，即输出完整的API文档；
生成部分API文档的具体步骤如下：
（一）、将概览文件中所需部分的API属性值复制到系统剪切板；
（二）、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
（三）、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
（四）、循环重复步骤（一）到步骤（三），直到概览文件读取完成，即输出生成部分API文档。
2.根据权利要求1所述的基于python与正则表达式的API文档自动生成方法，其特征在于，所述概览文件为API文档的目录概览，概览文件中包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅。
3.根据权利要求1或2所述的基于python与正则表达式的API文档自动生成方法，其特征在于，所述概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
4.根据权利要求1所述的基于python与正则表达式的API文档自动生成方法，其特征在于，所述API模板用于定义API的公共格式，使用python占位符放置于API可匹配的属性值位置，填充匹配数据；其中，API模板能够自由定义，提高了API文档格式的丰富性。
5.一种基于python与正则表达式的API文档自动生成系统，其特征在于，该系统包括，
概览文件建立模块，用于建立API文档的目录概览文件，概览文件包含API中可匹配的属性值，起到目录索引的作用，方便API详情查阅；
 API模板建立模块，用于定义API的公共格式，使用python占位符放置于API可匹配属性值位置，填充匹配数据；
识别匹配模块，用于识别概览文件并匹配属性值，再循环填充API模板生成API文档文件；
其中，生成API文档文件包括生成全部API文档文件和生成部分API文档文件；
所述生成全部API文档文件的工作过程具体如下：
（1）、识别匹配模块打开准备好的概览文件；
（2）、识别匹配模块读取并识别匹配每条API的属性值放入内存；
（3）、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
（4）、循环重复步骤（1）到步骤（3），直到概览文件读取完成，即输出完整的API文档文件；
所述生成部分API文档文件的工作过程具体如下：
（一）、将概览文件中所需部分的API属性值复制到系统剪切板；
（二）、识别匹配模块读取剪贴板数据，与API模板合作识别匹配每条API的属性值放入内存；
（三）、将内存中的属性值填充API模板中对应的占位符，再将该条填充好的API模板写入API文档中，并判断API文档是否存在：
①、若存在，则写入；
②、若不存在，则新建；
（四）、循环重复步骤（一）到步骤（三），直到概览文件读取完成，即输出生成部分API文档文件。
6.根据权利要求5所述的基于python与正则表达式的API文档自动生成系统，其特征在于，所述概览文件为markdown格式或文本形式，概览文件为markdown格式时能够被识别匹配模块匹配属性值，通过链接跳转的方式查阅API文档详细内容；markdown格式为文本形式时仅能够被识别匹配模块匹配属性值，无法起到链接跳转的作用。
CN202010161235.4A 2020-03-10 2020-03-10 一种基于python与正则表达式的API文档自动生成方法及系统 Active CN111399900B (zh)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN202010161235.4A CN111399900B (zh) 2020-03-10 2020-03-10 一种基于python与正则表达式的API文档自动生成方法及系统

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN202010161235.4A CN111399900B (zh) 2020-03-10 2020-03-10 一种基于python与正则表达式的API文档自动生成方法及系统

Publications (2)

Publication Number Publication Date
CN111399900A CN111399900A (zh) 2020-07-10
CN111399900B true CN111399900B (zh) 2023-04-07

Family

ID=71432397

Family Applications (1)

Application Number Title Priority Date Filing Date
CN202010161235.4A Active CN111399900B (zh) 2020-03-10 2020-03-10 一种基于python与正则表达式的API文档自动生成方法及系统

Country Status (1)

Country Link
CN (1) CN111399900B (zh)

Families Citing this family (1)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN112668292B (zh) * 2020-12-30 2022-09-30 卡斯柯信号有限公司 一种从系统配置规则中自动提取追踪矩阵的方法及其应用

Citations (9)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN101976188A (zh) * 2010-05-26 2011-02-16 天津大学 面向AJAX协议的OpenApi数据自动加载系统
CN102541829A (zh) * 2012-01-17 2012-07-04 中国工商银行股份有限公司 一种多用户并发的电子文档生成装置及方法
CN106326194A (zh) * 2015-07-06 2017-01-11 北大方正集团有限公司 一种应用于文件格式转换场景下的目录生成方法和装置
CN107193570A (zh) * 2017-05-31 2017-09-22 郑州云海信息技术有限公司 一种自动生成api文档的方法及系统
CN110187916A (zh) * 2019-05-31 2019-08-30 四川长虹电器股份有限公司 基于数据配置生成Word文档的方法
CN110471698A (zh) * 2019-07-29 2019-11-19 深圳数位传媒科技有限公司 Api文档的生成方法与装置、存储介质及计算机设备
CN110764820A (zh) * 2019-10-31 2020-02-07 百卓网络科技有限公司 一种基于代码注释自动生成开发文档的方法及系统
JP2020024567A (ja) * 2018-08-07 2020-02-13 日本電信電話株式会社 Ａｐｉ仕様書生成装置、ａｐｉ仕様書生成方法、およびプログラム
CN110852079A (zh) * 2019-10-11 2020-02-28 平安科技（深圳）有限公司 文档目录自动生成方法、装置及计算机可读存储介质

Family Cites Families (7)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20020059348A1 (en) * 2000-11-14 2002-05-16 Cypress Semiconductor Corp. Automatic documentation generation tool and associated method
US7251777B1 (en) * 2003-04-16 2007-07-31 Hypervision, Ltd. Method and system for automated structuring of textual documents
CN103186514B (zh) * 2011-12-31 2016-04-20 北大方正集团有限公司 用于实现文档结构化的方法和装置
CN107122429A (zh) * 2017-04-13 2017-09-01 北京安云世纪科技有限公司 一种文件管理的方法和装置及移动终端
CN108459874B (zh) * 2018-03-05 2021-03-26 中国人民解放军国防科技大学 融合深度学习和自然语言处理的代码自动化摘要方法
CN110196733A (zh) * 2019-06-06 2019-09-03 深圳市伊欧乐科技有限公司 一种预设api文档生成方法、装置、设备和存储介质
CN110781082B (zh) * 2019-10-14 2022-05-20 腾讯科技（深圳）有限公司 接口的测试用例的生成方法及装置、介质和设备

Patent Citations (9)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN101976188A (zh) * 2010-05-26 2011-02-16 天津大学 面向AJAX协议的OpenApi数据自动加载系统
CN102541829A (zh) * 2012-01-17 2012-07-04 中国工商银行股份有限公司 一种多用户并发的电子文档生成装置及方法
CN106326194A (zh) * 2015-07-06 2017-01-11 北大方正集团有限公司 一种应用于文件格式转换场景下的目录生成方法和装置
CN107193570A (zh) * 2017-05-31 2017-09-22 郑州云海信息技术有限公司 一种自动生成api文档的方法及系统
JP2020024567A (ja) * 2018-08-07 2020-02-13 日本電信電話株式会社 Ａｐｉ仕様書生成装置、ａｐｉ仕様書生成方法、およびプログラム
CN110187916A (zh) * 2019-05-31 2019-08-30 四川长虹电器股份有限公司 基于数据配置生成Word文档的方法
CN110471698A (zh) * 2019-07-29 2019-11-19 深圳数位传媒科技有限公司 Api文档的生成方法与装置、存储介质及计算机设备
CN110852079A (zh) * 2019-10-11 2020-02-28 平安科技（深圳）有限公司 文档目录自动生成方法、装置及计算机可读存储介质
CN110764820A (zh) * 2019-10-31 2020-02-07 百卓网络科技有限公司 一种基于代码注释自动生成开发文档的方法及系统

Non-Patent Citations (2)

* Cited by examiner, † Cited by third party
Title
古辉 ; 王艳春 ; 马灵春 ; .基于GXL的软件文档生成的研究.浙江工业大学学报.2008,(第03期),全文. *
邵欣欣 ; 张明会 ; 高梓峻 ; .文档生成技术研究与应用.软件工程.2018,(第01期),全文. *

Also Published As

Publication number Publication date
CN111399900A (zh) 2020-07-10

Similar Documents

Publication Publication Date Title
CN101334728B (zh) 一种基于xml文档描述的界面生成方法和装置
CN101661460B (zh) 管理系统报表生成方法和装置
CN104133772A (zh) 一种自动生成测试数据的方法
CN102096588A (zh) 一种包含控件的页面的建立方法
CN103970737A (zh) 一种数据构造方法和装置
WO2009105994A1 (zh) 一种处理符合文档库标准的文档的方法及装置
CN110187916B (zh) 基于数据配置生成Word文档的方法
CN100338605C (zh) 一种可扩展标记语言文档修改痕迹的记录方法
CN110543299A (zh) 一种云计算管理平台代码生成方法和装置
CN111399900B (zh) 一种基于python与正则表达式的API文档自动生成方法及系统
CN113655996B (zh) 一种基于需求模型的企业级系统生成方法
CN103309849A (zh) 一种基于OpenXML的docx文档创建和修改方法
CN117077650A (zh) 基于动态模板配置的文档生成系统、方法、设备及介质
CN114895875B (zh) 一种零代码可视化信息系统元数据的生产应用方法及系统
KR101022716B1 (ko) 전자문서 자동생성시스템 및 자동생성방법
CN109542453A (zh) 数据库信息识别方法、装置及计算机终端
CN113569543B (zh) 一种核电工程自动报告生成技术的实现方法
CN115713309A (zh) 内审系统
CN101241435A (zh) 一种快速将以前业务系统移植到平台中的方法
CN108073395A (zh) 一种生成式编程方法
CN107844639B (zh) 一种项目标准结构自动生成方法及系统
CN111522815A (zh) 一种企业基本信息入库的方法
CN117350249B (zh) 一种电子文档数据自动录入的控件配置方法及系统
CN114035726B (zh) 一种机器人流程自动化页面要素识别过程的方法及系统
CN117931752A (zh) 一种基于Excel VBA的工艺文件生成方法

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
GR01 Patent grant
GR01 Patent grant