A method, system, computing device and storage medium for generating interface documents

Automatically generate interface documents through JavaAgent technology, solving the problems of cumbersome interface document maintenance and high code intrusion in the existing technology, realizing non-invasive interface document automation generation and unified field naming and description, and improving development and testing efficiency.

CN114153495BActive Publication Date: 2025-03-28CHEZHI HULIAN BEIJING SCI & TECH CO LTD
2 Cites 0 Cited by

Patent Information

Application Number
CN202111484623.7
Authority / Receiving Office
CN · China
Patent Type
Patents(China)
Current Assignee / Owner
Filing Date
2021-12-07
Publication Date
2025-03-28
Estimated Expiration
2041-12-07

AI Technical Summary

Technical Problem

In Java web applications developed based on SpringBoot, existing interface document generation tools require developers to maintain a large number of comments and field descriptions in the code, resulting in high intrusion, time-consuming and labor-intensive code, and inconsistent field naming and descriptions.

Method used

JavaAgent technology is used to automatically generate interface documents, and through the combination of interface information acquisition units, message queues and interface document platforms, it realizes intrusive automatic generation of interface documents.

Benefits of technology

It realizes automatic generation of interface documents without the need for developers to write instructions in the code, ensures that the interface field naming and description are unified, reduces interface document maintenance and improves development and testing efficiency.

✦ Generated by Eureka AI based on patent content.
Patent Text Reader

Abstract

The present invention discloses an interface document generation method, system, computing device and storage medium. The interface document generation system comprises an interface information acquisition unit, a message queue and an interface document platform. The interface information acquisition unit is suitable for starting after a target project is started, and after binding itself to the target project, the proxy unit loads the interface information of the web interface in the target project based on the class loaded by the target project, and the interface information is encapsulated into an interface object and then reported to the message queue; the interface document platform is suitable for acquiring the interface object from the message queue, parsing the interface object into interface information, generating an interface parameter table of the web interface based on the parsed interface information, and adding an entry about the web interface in the interface basic information table.
Need to check novelty before this filing date? Find Prior Art