CN110442378B - 接口文档的修改方法和系统 - Google Patents
接口文档的修改方法和系统 Download PDFInfo
- Publication number
- CN110442378B CN110442378B CN201910589573.5A CN201910589573A CN110442378B CN 110442378 B CN110442378 B CN 110442378B CN 201910589573 A CN201910589573 A CN 201910589573A CN 110442378 B CN110442378 B CN 110442378B
- Authority
- CN
- China
- Prior art keywords
- interface
- terminal
- description information
- modification
- 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.)
- Active
Links
- 238000000034 method Methods 0.000 title claims abstract description 38
- 238000012986 modification Methods 0.000 claims abstract description 223
- 230000004048 modification Effects 0.000 claims abstract description 223
- 238000012790 confirmation Methods 0.000 claims description 11
- 238000005516 engineering process Methods 0.000 claims description 10
- 238000012827 research and development Methods 0.000 abstract 1
- 238000011161 development Methods 0.000 description 23
- 238000010586 diagram Methods 0.000 description 5
- 230000001360 synchronised effect Effects 0.000 description 2
- 230000000007 visual effect Effects 0.000 description 2
- 238000004590 computer program Methods 0.000 description 1
- 238000012217 deletion Methods 0.000 description 1
- 230000037430 deletion Effects 0.000 description 1
- 238000002715 modification method Methods 0.000 description 1
- 230000003068 static effect Effects 0.000 description 1
- 238000012800 visualization Methods 0.000 description 1
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
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)
- Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
Abstract
本申请涉及研发管理领域，提供了一种接口文档的修改方法和系统。其中的方法包括：第一终端接收服务器发送的接口文档，并检测对所述接口文档的修改操作；当所述第一终端成功检测到对所述接口文档进行修改操作时，获取所述修改操作对应的修改操作类型及修改数据并根据所述修改操作类型及所述修改数据生成接口文档修改指令，将所述接口文档修改指令发送至服务器；所述服务器根据所述接口文档修改指令生成接口文档修改请求，并将所述接口文档修改请求发送至第二终端；所述第二终端根据所述接口文档修改请求对所述接口文档进行修改。采用本申请的方法可以提高对接口文档的修改效率。
Description
技术领域
本申请涉及互联网技术领域，特别是涉及一种接口文档的修改方法和系统。
背景技术
在目前的web项目开发模式中，最常用的是web开发端和服务开发端开发分离的模式，即web开发端和服务开发端各自独立开发。在这种模式中，前端开发经常会遇到需要调用后端接口但是后端接口并未开发好的，为了保证前端的开发效率，通常由后端开发人员提供一份接口文档给前端，前端可通过接口文档对接口进行模拟来获取接口数据。web开发端在获取到接口文档后，还有可能对接口文档进行修改，传统技术，当web开发端对接口文档进行修改后，由于web开发端和服务开发端各自独立开发，服务开发端无法及时获知到修改情况，导致服务开发端对接口文档的修改效率低下。
发明内容
基于此，有必要针对上述技术问题，提供一种能够提高对接口文档的修改效率的接口文档的修改方法和系统。
一种接口文档的修改方法，所述方法包括：
第一终端接收服务器发送的接口文档，并检测对所述接口文档的修改操作；所述接口文档是根据第二终端存储的目标代码文件生成的；
当所述第一终端成功检测到对所述接口文档进行修改操作时，获取所述修改操作对应的修改操作类型及修改数据并根据所述修改操作类型及所述修改数据生成接口文档修改指令，将所述接口文档修改指令发送至服务器；
所述服务器根据所述接口文档修改指令生成接口文档修改请求，并将所述接口文档修改请求发送至第二终端；
所述第二终端根据所述接口文档修改请求对所述接口文档进行修改。
在其中一个实施例中，在所述第一终端接收服务器发送的接口文档之前，还包括：
所述第二终端采用javadoc技术解析所述目标代码文件，得到接口描述信息；
所述第二终端对所述接口描述信息进行格式化，得到Json格式的接口文档，将所述接口文档发送至所述服务器。
在其中一个实施例中，在所述第一终端接收服务器发送的接口文档之后，还包括：
所述第一终端显示当前展示模板集合；
所述第一终端接收对所述当前展示模板集合的选择操作，将所述选择操作对应的展示模板确定为目标展示模板；
所述第一终端将所述接口文档对应的接口描述信息读取至所述目标展示模板中，以对所述接口文档进行展示。
在其中一个实施例中，所述第二终端根据所述接口文档修改请求对所述接口文档进行修改，包括：
所述第二终端解析所述接口文档修改请求，以获取所述修改操作类型及所述修改数据；
当所述第二终端检测到根据所述修改操作类型及所述修改数据修改的目标代码文件时，获取修改后的所述目标代码文件对应的接口描述信息；
所述第二终端将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异，其中，原始接口描述信息为修改前的目标代码文件对应的接口描述信息；
所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改。
在其中一个实施例中，修改后的接口描述信息与原始接口描述信息之间的差异包括：修改后的接口描述信息与原始接口描述信息相比所增加的接口描述信息、删除的接口描述信息和/或更改的接口描述信息；
所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改，包括：
所述第二终端对所增加的接口描述信息进行格式化，将得到的格式化数据添加至所述接口文档中；
或者所述第二终端将删除的接口描述信息所对应的格式化数据从接口文档中删除；
或者所述第二终端对所更改的接口描述信息进行格式化，并使用得到的格式化数据替换接口文档中对应的格式化数据。
在其中一个实施例中，在所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改之后，还包括：
所述第二终端将修改后的所述接口文档发送至所述服务器；
所述服务器接收到修改后的所述接口文档后，生成版本更新提醒信息，并将所述版本更新提醒信息发送至所述第一终端；
所述第一终端对所述版本更新提醒信息进行显示。
在其中一个实施例中，所述方法还包括：
所述服务器接收所述第一终端发送的联调状态查询请求，根据所述联调状态查询请求生成联调确认指令，将所述联调确认指令发送至所述第二终端；
所述服务器接收所述第二终端对所述联调确认指令的反馈信息，将所述反馈信息发送至所述第一终端，所述第一终端对所述反馈信息进行显示。
一种接口文档的修改系统，所述系统包括第一终端、第二终端及服务器，其中：
第一终端用于接收服务器发送的接口文档，并检测对所述接口文档的修改操作；当成功检测到对所述接口文档进行修改操作时，获取所述修改操作对应的修改操作类型及修改数据并根据所述修改操作类型及所述修改数据生成接口文档修改指令，将所述接口文档修改指令发送至服务器；所述接口文档是根据第二终端存储的目标代码文件生成的；
所述服务器用于根据所述接口文档修改指令生成接口文档修改请求，并将所述接口文档修改请求发送至第二终端；
所述第二终端用于根据所述接口文档修改请求对所述接口文档进行修改。
在其中一个实施例中，所述第一终端还用于显示当前展示模板集合，接收对所述当前展示模板集合的选择操作，将所述选择操作对应的展示模板确定为目标展示模板，将所述接口文档对应的接口描述信息读取至所述目标展示模板中，以对所述接口文档进行展示。
在其中一个实施例中，所述第二终端还用于解析所述接口文档修改请求，以获取所述修改操作类型及所述修改数据，当检测到根据所述修改操作类型及所述修改数据修改的目标代码文件时，获取修改后的所述目标代码文件对应的接口描述信息，将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异，根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改，其中，原始接口描述信息为修改前的目标代码文件对应的接口描述信息。
上述接口文档的修改方法和系统，第一终端在检测到接口文档被修改后，能够获取修改数据及修改操作类型并根据修改数据及修改操作类型生成接口文档修改指令发送到服务器，服务器根据该接口文档修改指令生成接口文档修改请求发送到第二终端，使得第二终端能够及时获知接口文档的修改请求，以对接口文档及时进行修改，从而可以提高对接口文档的修改效率。
附图说明
图1为一个实施例中接口文档的修改方法的应用场景图；
图2为一个实施例中接口文档的修改方法的流程示意图；
图3为一个实施例中对接口文档进行可视化展示的流程示意图；
图4为一个实施例中第二终端对接口文档进行修改的流程示意图；
图5为一个实施例中接口文档的修改系统的结构框图。
具体实施方式
为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处描述的具体实施例仅仅用以解释本申请，并不用于限定本申请。
本申请提供的接口文档的修改方法，可以应用于如图1所示的应用环境中。其中，第一终端102、第二终端104通过网络与服务器106进行通信，第一终端102为web开发端，第二终端104为该web端开发端对应的服务开发端。第一终端在接收到服务器发送的接口文档后，可检测作用于接口文档的修改操作，当成功检测到修改操作时，获取修改操作对应的修改数据及修改操作类型，并根据修改数据及修改操作类型生成接口文档修改指令，将接口文档修改指令发送至服务器，服务器进一步根据接口文档修改指令生成接口文档修改请求，并将接口文档修改请求发送至第二终端，第二终端在接收到接口文档修改请求后，可以根据接口文档修改请求对接口文档进行修改。
其中，终端102可以但不限于是各种个人计算机、笔记本电脑、智能手机、平板电脑和便携式可穿戴设备，服务器104可以用独立的服务器或者是多个服务器组成的服务器集群来实现。
在一个实施例中，如图2所示，提供了一种接口文档的修改方法，包括以下步骤：
步骤S202，第一终端接收服务器发送的接口文档，并检测对接口文档的修改操作。
其中，接口文档是根据第二终端存储的目标代码文件生成的。目标代码文件指的是与当前需要生成接口文档的接口对应的代码文件，目标代码文件包含了java注释。第一终端为web开发端，第二终端为该web端开发端对应的服务开发端。
在一个实施例中，第二终端可以根据目标代码文件中的java注释生成接口文档，将生成的接口文档发送至服务器。在另一个实施例中，第二终端可以将目标代码文件发送至服务器，由服务器根据目标代码文件中的java注释生成接口文档。
进一步，服务器可将接口文档保存到数据库中。当接收到第一终端的接口文档查询请求时，服务器可从数据库中进行查询，并将查询到的接口文档发送至第一终端。
在一个实施例中，接口文档为json格式的文档。
步骤S204，当第一终端成功检测到对接口文档进行修改操作时，获取修改操作对应的修改数据及修改操作类型并根据修改数据及修改操作类型生成接口文档修改指令，将接口文档修改指令发送至服务器。
其中，修改操作包括替换数据、删除数据及增加数据三种类型，修改操作对应的修改数据包括经过修改操作删除的数据、替换的数据及增加的数据中至少一种，比如，当第一终端检测到对接口文档的修改操作为删除某个输入参数时，则修改操作对应的修改数据为该删除的输入参数。接口文档修改指令是根据修改操作类型及修改数据生成的，因此接口文档修改指令携带修改操作类型及对应的修改数据。
可以理解的是，在一个实施例中，为避免因为web端开发人员的误操作而引起不必要的修改，第一终端可设置修改确定按钮，第一终端只有在检测到用户点击该修改确认按钮时，才判定成功检测到对接口文档的修改操作。
步骤S206，服务器根据接口文档修改指令生成接口文档修改请求，并将接口文档修改请求发送至第二终端。
步骤S208，第二终端根据接口文档修改请求对接口文档进行修改。
具体地，服务器接收到接口文档修改指令后，解析该接口文档修改指令，得到修改操作类型及修改操作对应的修改数据，根据得到的修改操作类型及修改操作对应的修改数据生成接口文档修改请求。
进一步，服务器将接口文档修改请求发送至第二终端。第二终端在接收到接口文档修改请求后，解析该接口文档修改请求，以获取修改操作类型及修改数据。
在一个实施例中，第二终端可根据修改操作类型及修改数据生成提示信息，以提示服务端开发人员根据修改操作类型及修改数据对目标代码文件进行修改，同时，第二终端可以检测对目标代码文件的修改操作，当成功检测到对目标代码文件的修改操作时，根据修改后的目标代码文件对接口文档进行修改。
上述接口文档的修改方法中，第一终端在检测到接口文档被修改后，能够获取修改数据及修改操作类型并根据修改数据及修改操作类型生成接口文档修改指令发送到服务器，服务器根据该接口文档修改指令生成接口文档修改请求发送到第二终端，使得第二终端能够及时获知接口文档的修改请求，以对接口文档及时进行修改，从而可以提高对接口文档的修改效率。
进一步，由于web端开发人员可以直接在接口文档上进行修改，相较于传统技术中线下方式进行沟通，准确性更高，服务端开发人员可以准确的知道前端开发需要修改的数据。
在一个实施例中，如图3所示，上述步骤S202中在第一终端接收服务器发送的接口文档之后，上述方法还包括：
步骤S302，第一终端显示当前展示模板集合。
其中，当前展示模板集合指的是第一终端上可用于展示接口文档的多个可视化的展示模板组成的集合。
步骤S304，第一终端接收对当前展示模板集合的选择操作，将选择操作对应的展示模板确定为目标展示模板。
具体地，web端开发人员可从当前展示模板集合中选择展示模板，当第一终端接收到web端开发人员的选择操作时，可将选择操作对应的展示模板确定为目标展示模板。
在一个实施例中，web端开发人员可预先设置默认的展示模板，当第一终端在预设时间段内没有检测到web端开发人员选择展示模板的选择操作时，通过默认的可视化模板对接口文档进行展示。
步骤S306，第一终端将接口文档对应的接口描述信息读取至目标展示模板中，以对接口文档进行展示。
在一个实施例中，由于第一终端接收到的接口文档为json格式的数据，是对接口描述信息格式化得到的，因此第一终端可以先对接口文档进行解析，以获取接口文档中的接口描述信息，然后将接口描述信息读取至目标模板中，以实现对接口文档的可视化展示。
上述实施例中，由于设置了多个展示模板，并可以根据用户的选择操作来选择展示模板对接口文档进行展示，可以很好的满足web端开发人员对接口文档的展示需求。
在一个实施例中，在第一终端接收服务器发送的接口文档之前，上述方法还包括：第二终端采用javadoc技术解析目标代码文件，得到接口描述信息，对接口描述信息进行格式化，得到Json格式的接口文档。
具体地，服务端开发人员在编写接口的目标代码文件时，可以以一套特定的标签给目标代码文件添加注释，这样第二终端在生成接口文档时，就可以直接采用javadoc技术从目标代码文件中抽取类、方法、成员等注释信息，并对这些注释信息进行解析，得到接口描述信息，接口描述信息包括接口URL地址、接口参数、返回值、错误码等信息，然后第二终端对接口描述信息进行格式化处理，得到Json格式的接口文档。
上述实施例中，通过javadoc技术解析目标代码文件，得到接口描述信息，并对接口描述信息进行格式化，得到Json格式的接口文档，从而实现了接口文档的自动生成，节省了服务端开发人员编写接口文档的时间，从而提高了开发效率。
在一个实施例中，如图4所示，上述步骤S208中第二终端根据接口文档修改请求对接口文档进行修改，包括：
步骤S402，第二终端解析接口文档修改请求，以获取修改操作类型及修改数据，当检测到根据修改操作类型及修改数据修改的目标代码文件时，获取修改后的目标代码文件对应的接口描述信息。
在一个实施例中，第二终端可根据修改操作类型及修改数据生成提示信息，以提示服务端开发人员对根据修改操作类型及修改数据对目标代码文件进行修改，同时，第二终端可以检测对目标代码文件的修改操作，当成功检测到对目标代码文件的修改操作时，则表示检测到根据修改操作类型及修改数据修改的目标代码文件，进一步，第二终端采用javadoc技术解析修改后的目标代码文件，得到修改后的目标代码文件对应的接口描述信息。
步骤S404，第二终端将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异。
步骤S406，第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对接口文档进行修改。
其中，修改后的接口描述信息与原始接口描述信息之间的差异包括：修改后的接口描述信息与原始接口描述信息相比所增加的接口描述信息、删除的接口描述信息和/或更改的接口描述信息。
根据修改后的接口描述信息与原始接口描述信息之间的差异对接口文档进行修改，包括：对所增加的接口描述信息进行格式化，将得到的格式化数据添加至接口文档中；或者将删除的接口描述信息所对应的格式化数据从接口文档中删除；或者对所更改的接口描述信息进行格式化，并使用得到的格式化数据替换接口文档中对应的格式化数据。
在一个实施例中，在第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对接口文档进行修改之后，上述方法还包括：第二终端将修改后的接口文档发送至服务器；服务器接收到修改后的接口文档后，生成版本更新提醒信息，并将版本更新提醒信息发送至第一终端；第一终端对版本更新提醒信息进行显示。
具体地，服务器在接收到修改后的接口文档后，可以用修改后的接口文档替换数据库中存储的原始接口文档，其中，原始接口文档指的是代码文件修改之前的接口文档。进一步，服务器获取修改之后的接口文档的版本号，根据该版本号生成版本更新提醒信息，将版本更新提醒信息发送至第一终端，第一终端对版本更新提醒信息进行显示，以提醒web端开发人员该接口文档已经更新。
上述实施例中，当目标代码文件被进行修改时，第二终端首先检查代码文件对应的接口描述信息中哪些数据进行了修改，根据修改的那部分接口描述信息对接口文档进行修改，由于不需要对接口文档进行全部修改，可以加快接口文档的修改速度。
在一个实施例中，上述方法还包括：服务器接收第一终端发送的联调状态查询请求，根据联调状态查询请求生成联调确认指令，将联调确认指令发送至第二终端，接收第二终端对联调确认指令的反馈信息，将反馈信息发送至第一终端，第一终端对反馈信息进行显示。
具体地，当web端开发人员需要判断是否可以进行联调时，可通过第一终端向服务器发送联调状态查询请求，联调状态查询请求中包含待联调的接口对应的接口标识，服务器根据接口标识生成联调状态查询指令，将联调状态查询指令发送至第二终端，第二终端接收到联调状态查询指令后可显示两个反馈信息选项，其中一个反馈信息选项用于表征不能进行联调，例如“尚在开发中”，另一个反馈信息选择用于表征可以进行联调，例如“确认联调”。
当服务端开发人员选择的是用于表征不能进行联调的反馈信息选项时，第二终端将该反馈信息发送至服务器，服务器可以将该反馈信息发送至第一终端，第一终端对该反馈信息进行显示，以提示web端开发人员接口还处于开发状态；当服务端开发人员选择的是用于表征可以进行联调的反馈信息选项时，第二终端可以获取web端联调所需要的接口数据，将该反馈信息以及联调所需要的接口数据一起发送至服务器，服务器将联调所需要的接口数据保存至数据库中，并将反馈信息发送至第一终端，第一终端对反馈信息进行显示，以提示用于可以开始联调。
进一步，web端开发人员可通过第一终端从服务器获取联调所需要的接口数据。
上述实施例中，服务器在接收到第一终端发送的联调状态查询请求后，根据联调状态查询请求生成联调确认指令，将联调确认指令发送至第二终端，在接收到第二终端的反馈信息，将反馈信息发送至第一终端，使得第一终端可以获得准确的反馈信息，并对反馈信息进行显示，从而提高了web端开发人员对是否可以进行联调判断的准确性。
应该理解的是，虽然图2-4的流程图中的各个步骤按照箭头的指示依次显示，但是这些步骤并不是必然按照箭头指示的顺序依次执行。除非本文中有明确的说明，这些步骤的执行并没有严格的顺序限制，这些步骤可以以其它的顺序执行。而且，图2-4中的至少一部分步骤可以包括多个子步骤或者多个阶段，这些子步骤或者阶段并不必然是在同一时刻执行完成，而是可以在不同的时刻执行，这些子步骤或者阶段的执行顺序也不必然是依次进行，而是可以与其它步骤或者其它步骤的子步骤或者阶段的至少一部分轮流或者交替地执行。
在一个实施例中，如图5所示，提供了一种接口文档的修改系统500，该系统包括第一终端502、第二终端504及服务器506，其中：
第一终端502用于接收服务器发送的接口文档，并检测对接口文档的修改操作；当成功检测到对接口文档进行修改操作时，获取修改操作对应的修改操作类型及修改数据并根据修改操作类型及修改数据生成接口文档修改指令，将接口文档修改指令发送至服务器；接口文档是根据第二终端存储的目标代码文件生成的；
服务器506用于根据接口文档修改指令生成接口文档修改请求，并将接口文档修改请求发送至第二终端；
第二终端504用于根据接口文档修改请求对接口文档进行修改。
上述接口文档的修改系统中，第一终端在检测到接口文档被修改后，能够获取修改数据及修改操作类型并根据修改数据及修改操作类型生成接口文档修改指令发送到服务器，服务器根据该接口文档修改指令生成接口文档修改请求发送到第二终端，使得第二终端能够及时获知接口文档的修改请求，以对接口文档及时进行修改，从而可以提高对接口文档的修改效率。
在一个实施例中，第二终端504还用于采用javadoc技术解析目标代码文件，得到接口描述信息；对接口描述信息进行格式化，得到Json格式的接口文档，将接口文档发送至服务器。
在一个实施例中，第一终端502还用于显示当前展示模板集合；接收对当前展示模板集合的选择操作，将选择操作对应的展示模板确定为目标展示模板；将接口文档对应的接口描述信息读取至目标展示模板中，以对接口文档进行展示。
在一个实施例中，第二终端504还用于解析接口文档修改请求，以获取修改操作类型及修改数据；当检测到根据修改操作类型及修改数据修改的目标代码文件时，获取修改后的目标代码文件对应的接口描述信息；将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异，其中，原始接口描述信息为修改前的目标代码文件对应的接口描述信息；根据修改后的接口描述信息与原始接口描述信息之间的差异对接口文档进行修改。
在一个实施例中，修改后的接口描述信息与原始接口描述信息之间的差异包括：修改后的接口描述信息与原始接口描述信息相比所增加的接口描述信息、删除的接口描述信息和/或更改的接口描述信息；第二终端502还用于：对所增加的接口描述信息进行格式化，将得到的格式化数据添加至接口文档中；或者将删除的接口描述信息所对应的格式化数据从接口文档中删除；或者对所更改的接口描述信息进行格式化，并使用得到的格式化数据替换接口文档中对应的格式化数据。
在一个实施例中，第二终端504还用于将修改后的接口文档发送至服务器506；服务器506还用于接收到修改后的接口文档后，生成版本更新提醒信息，并将版本更新提醒信息发送至第一终端502；第一终端502还用于对版本更新提醒信息进行显示。
在一个实施例中，服务器506还用于接收第一终端502发送的联调状态查询请求，根据联调状态查询请求生成联调确认指令，将联调确认指令发送至第二终端504，接收第二终端504对联调确认指令的反馈信息，将反馈信息发送至第一端502，第一终端502对反馈信息进行显示。
关于接口文档的修改系统的具体限定可以参见上文中对于接口文档的修改方法的限定，在此不再赘述。
本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程，是可以通过计算机程序来指令相关的硬件来完成，所述的计算机程序可存储于一非易失性计算机可读取存储介质中，该计算机程序在执行时，可包括如上述各方法的实施例的流程。其中，本申请所提供的各实施例中所使用的对存储器、存储、数据库或其它介质的任何引用，均可包括非易失性和/或易失性存储器。非易失性存储器可包括只读存储器(ROM)、可编程ROM(PROM)、电可编程ROM(EPROM)、电可擦除可编程ROM(EEPROM)或闪存。易失性存储器可包括随机存取存储器(RAM)或者外部高速缓冲存储器。作为说明而非局限，RAM以多种形式可得，诸如静态RAM(SRAM)、动态RAM(DRAM)、同步DRAM(SDRAM)、双数据率SDRAM(DDRSDRAM)、增强型SDRAM(ESDRAM)、同步链路(Synchlink)DRAM(SLDRAM)、存储器总线(Rambus)直接RAM(RDRAM)、直接存储器总线动态RAM(DRDRAM)、以及存储器总线动态RAM(RDRAM)等。
以上实施例的各技术特征可以进行任意的组合，为使描述简洁，未对上述实施例中的各个技术特征所有可能的组合都进行描述，然而，只要这些技术特征的组合不存在矛盾，都应当认为是本说明书记载的范围。
以上所述实施例仅表达了本申请的几种实施方式，其描述较为具体和详细，但并不能因此而理解为对发明专利范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本申请构思的前提下，还可以做出若干变形和改进，这些都属于本申请的保护范围。因此，本申请专利的保护范围应以所附权利要求为准。
Claims (10)
1.一种接口文档的修改方法，所述方法包括：
第一终端接收服务器发送的接口文档，并检测对所述接口文档的修改操作；所述接口文档是根据第二终端存储的目标代码文件生成的；
当所述第一终端成功检测到对所述接口文档进行修改操作时，获取所述修改操作对应的修改操作类型及修改数据并根据所述修改操作类型及所述修改数据生成接口文档修改指令，将所述接口文档修改指令发送至服务器；
所述服务器根据所述接口文档修改指令生成接口文档修改请求，并将所述接口文档修改请求发送至第二终端；
所述第二终端解析所述接口文档修改请求，以获取所述修改操作类型及所述修改数据；
当所述第二终端检测到根据所述修改操作类型及所述修改数据修改的目标代码文件时，获取修改后的所述目标代码文件对应的接口描述信息；
所述第二终端将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异，其中，原始接口描述信息为修改前的目标代码文件对应的接口描述信息；
所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改；
修改后的接口描述信息与原始接口描述信息之间的差异包括：修改后的接口描述信息与原始接口描述信息相比所增加的接口描述信息、删除的接口描述信息和/或更改的接口描述信息；
所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改，包括：
所述第二终端对所增加的接口描述信息进行格式化，将得到的格式化数据添加至所述接口文档中；
或者所述第二终端将删除的接口描述信息所对应的格式化数据从接口文档中删除；
或者所述第二终端对所更改的接口描述信息进行格式化，并使用得到的格式化数据替换接口文档中对应的格式化数据。
2.根据权利要求1所述的方法，其特征在于，在所述第一终端接收服务器发送的接口文档之前，还包括：
所述第二终端采用javadoc技术解析所述目标代码文件，得到接口描述信息；
所述第二终端对所述接口描述信息进行格式化，得到Json格式的接口文档，将所述接口文档发送至所述服务器。
3.根据权利要求1所述的方法，其特征在于，在所述第一终端接收服务器发送的接口文档之后，还包括：
所述第一终端显示当前展示模板集合；
所述第一终端接收对所述当前展示模板集合的选择操作，将所述选择操作对应的展示模板确定为目标展示模板；
所述第一终端将所述接口文档对应的接口描述信息读取至所述目标展示模板中，以对所述接口文档进行展示。
4.根据权利要求1所述的方法，其特征在于，在所述第二终端根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改之后，还包括：
所述第二终端将修改后的所述接口文档发送至所述服务器；
所述服务器接收到修改后的所述接口文档后，生成版本更新提醒信息，并将所述版本更新提醒信息发送至所述第一终端；
所述第一终端对所述版本更新提醒信息进行显示。
5.根据权利要求1至4任意一项所述的方法，其特征在于，所述方法还包括：
所述服务器接收所述第一终端发送的联调状态查询请求，根据所述联调状态查询请求生成联调确认指令，将所述联调确认指令发送至所述第二终端；
所述服务器接收所述第二终端对所述联调确认指令的反馈信息，将所述反馈信息发送至所述第一终端，所述第一终端对所述反馈信息进行显示。
6.一种接口文档的修改系统，其特征在于，所述系统包括第一终端、第二终端及服务器，其中：
第一终端用于接收服务器发送的接口文档，并检测对所述接口文档的修改操作；当成功检测到对所述接口文档进行修改操作时，获取所述修改操作对应的修改操作类型及修改数据并根据所述修改操作类型及所述修改数据生成接口文档修改指令，将所述接口文档修改指令发送至服务器；所述接口文档是根据第二终端存储的目标代码文件生成的；
所述服务器用于根据所述接口文档修改指令生成接口文档修改请求，并将所述接口文档修改请求发送至第二终端；
所述第二终端用于解析所述接口文档修改请求，以获取所述修改操作类型及所述修改数据，当检测到根据所述修改操作类型及所述修改数据修改的目标代码文件时，获取修改后的所述目标代码文件对应的接口描述信息，将修改后的目标代码文件对应的接口描述信息与预先保存的原始接口描述信息进行对比，得到修改后的接口描述信息与原始接口描述信息之间的差异，根据修改后的接口描述信息与原始接口描述信息之间的差异对所述接口文档进行修改，其中，原始接口描述信息为修改前的目标代码文件对应的接口描述信息；
修改后的接口描述信息与原始接口描述信息之间的差异包括：修改后的接口描述信息与原始接口描述信息相比所增加的接口描述信息、删除的接口描述信息和/或更改的接口描述信息；所述第二终端还用于：对所增加的接口描述信息进行格式化，将得到的格式化数据添加至所述接口文档中；或者将删除的接口描述信息所对应的格式化数据从接口文档中删除；或者对所更改的接口描述信息进行格式化，并使用得到的格式化数据替换接口文档中对应的格式化数据。
7.根据权利要求6所述的系统，其特征在于，所述第一终端还用于显示当前展示模板集合，接收对所述当前展示模板集合的选择操作，将所述选择操作对应的展示模板确定为目标展示模板，将所述接口文档对应的接口描述信息读取至所述目标展示模板中，以对所述接口文档进行展示。
8.根据权利要求6所述的系统，其特征在于，所述第二终端还用于采用javadoc技术解析目标代码文件，得到接口描述信息，对所述接口描述信息进行格式化，得到Json格式的接口文档，将接口文档发送至所述服务器。
9.根据权利要求6所述的系统，其特征在于，所述第二终端还用于将修改后的接口文档发送至服务器；所述服务器还用于接收到修改后的接口文档后，生成版本更新提醒信息，并将版本更新提醒信息发送至第一终端；所述第一终端还用于对版本更新提醒信息进行显示。
10.根据权利要求6至9任意一项所述的系统，其特征在于，所述服务器还用于接收所述第一终端发送的联调状态查询请求，根据所述联调状态查询请求生成联调确认指令，将联调确认指令发送至所述第二终端，接收所述第二终端对联调确认指令的反馈信息，将所述反馈信息发送至第一端，所述第一终端用于对反馈信息进行显示。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910589573.5A CN110442378B (zh) | 2019-06-27 | 2019-06-27 | 接口文档的修改方法和系统 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910589573.5A CN110442378B (zh) | 2019-06-27 | 2019-06-27 | 接口文档的修改方法和系统 |
Publications (2)
| Publication Number | Publication Date |
|---|---|
| CN110442378A CN110442378A (zh) | 2019-11-12 |
| CN110442378B true CN110442378B (zh) | 2024-01-05 |
Family
ID=68429505
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN201910589573.5A Active CN110442378B (zh) | 2019-06-27 | 2019-06-27 | 接口文档的修改方法和系统 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN110442378B (zh) |
Families Citing this family (7)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN111240653B (zh) * | 2019-12-31 | 2024-02-02 | 瑞庭网络技术（上海）有限公司 | 接口文档生成方法、装置及可读存储介质 |
| CN111796809A (zh) * | 2020-06-29 | 2020-10-20 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、电子设备及介质 |
| CN111984228B (zh) * | 2020-07-09 | 2023-12-12 | 招联消费金融有限公司 | 一种接口文档的处理方法、装置、计算机设备和存储介质 |
| CN112380281A (zh) * | 2020-10-30 | 2021-02-19 | 中国人寿保险股份有限公司 | 一种平台层代码生成方法、装置、电子设备及存储介质 |
| CN112416430A (zh) * | 2020-11-27 | 2021-02-26 | 亿企赢网络科技有限公司 | 一种接口文档生成方法、装置、设备及存储介质 |
| CN112799659A (zh) * | 2021-01-12 | 2021-05-14 | 杨飞 | 一种免编程自动生成数据接口的方法、装置及终端 |
| CN113971024B (zh) * | 2021-12-24 | 2022-02-25 | 云账户技术(天津)有限公司 | 接口管理方法、装置、电子设备以及可读存储介质 |
Citations (1)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN103514223A (zh) * | 2012-06-28 | 2014-01-15 | 阿里巴巴集团控股有限公司 | 一种数据仓库数据同步方法和系统 |
Family Cites Families (3)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US8165967B2 (en) * | 2007-06-05 | 2012-04-24 | International Business Machines Corporation | Request modification method and system |
| US20090300484A1 (en) * | 2008-06-03 | 2009-12-03 | Stephenson Kenneth J | system and method for local modification of remotely submitted document processing jobs |
| US20150317156A1 (en) * | 2014-05-01 | 2015-11-05 | Ca, Inc. | Systems and Methods for Automated Generation of Interactive Documentation Based on Web Application Description Language Files |
-
2019
- 2019-06-27 CN CN201910589573.5A patent/CN110442378B/zh active Active
Patent Citations (1)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN103514223A (zh) * | 2012-06-28 | 2014-01-15 | 阿里巴巴集团控股有限公司 | 一种数据仓库数据同步方法和系统 |
Non-Patent Citations (1)
| Title |
|---|
| XML技术在车载信息平台图形用户界面开发中的应用;于晶;《中国优秀硕士学位论文全文数据库 (信息科技辑)》(第08期);I138-322 * |
Also Published As
| Publication number | Publication date |
|---|---|
| CN110442378A (zh) | 2019-11-12 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN110442378B (zh) | 接口文档的修改方法和系统 | |
| CN111027295B (zh) | 数据处理方法、装置、计算机设备和存储介质 | |
| CN108932122B (zh) | 接口文档生成方法、装置、计算机设备和存储介质 | |
| CN110008455B (zh) | 表格编辑方法、装置、计算机设备和存储介质 | |
| KR101999409B1 (ko) | 예시에 의한 데이터 포매팅 기법 | |
| CN110209652B (zh) | 数据表迁移方法、装置、计算机设备和存储介质 | |
| CN109634841B (zh) | 电子装置、接口自动化测试方法及存储介质 | |
| CN108965383B (zh) | 文件同步方法、装置、计算机设备和存储介质 | |
| CN109361628B (zh) | 报文组装方法、装置、计算机设备和存储介质 | |
| CN108629567A (zh) | 报批信息处理方法、装置、计算机设备和存储介质 | |
| CN111858376A (zh) | 请求报文生成方法和接口测试方法 | |
| CN109062925A (zh) | 自动生成insert语句的方法、装置、计算机设备及存储介质 | |
| CN113282488B (zh) | 终端的测试方法及装置、存储介质、终端 | |
| CN110837429A (zh) | 一种web端线上代码智能修复方法及装置 | |
| CN105740219A (zh) | 一种报表的自定义方法及装置 | |
| CN108062714B (zh) | 年金数据发送方法、装置、计算机设备及存储介质 | |
| CN110795353B (zh) | 快应用的调试方法、装置、设备及存储介质 | |
| JP6481387B2 (ja) | 関連情報提供方法、関連情報提供装置及び関連情報提供プログラム | |
| CN112862449A (zh) | 结构化工单生成方法、装置、计算机设备和存储介质 | |
| CN111522881A (zh) | 业务数据处理方法、装置、服务器及存储介质 | |
| CN108897772B (zh) | 数据源补充方法、装置、计算机设备和存储介质 | |
| CN110109656B (zh) | 接口模拟方法、装置、计算机设备和存储介质 | |
| CN114371866A (zh) | 业务系统的版本重构测试方法、装置和设备 | |
| CN113626409B (zh) | 一种测试资料处理方法、装置、设备及存储介质 | |
| CN112559930B (zh) | 网页集成方法、装置、计算机设备以及存储介质 |
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 |