Method and device for interface document generation, computer device, and storage medium

Abstract

The invention relates to a method and a device for interface document generation, a computer device, and a storage medium. The method comprises: obtaining a code file, traversing classes of a plurality of interfaces recorded in the code file, and obtaining code annotation information corresponding to the currently traversed classes; finding a global parameter in the currently traversed class, andobtaining global parameter information from definition of the global parameter in the class and the code annotation information corresponding to the class; by traversing class methods in the classes,reflecting all interfaces contained in the classes, obtaining interface information of each interface from a method body corresponding to the traversed class method and the code annotation informationcorresponding to the class; adding the global parameter information to the interface information of all interfaces and writing the obtained interface information to an interface document. The methodcan automatically collect interface information and effectively improve generation efficiency of the interface documents.

Description

technical field [0001] The present application relates to the field of computer technology, in particular to a method, device, computer equipment and storage medium for generating an interface document. Background technique [0002] In the process of system development and system upgrade development, developers need to pre-agree on interface specifications and reflect the interface specifications in the form of interface documents. The traditional ways of generating interface documents include the following: [0003] Manual writing: Developers manually write interface documents during the development process. Obviously, this method of manually writing and modifying interface documents is time-consuming and poorly standardized. [0004] With the help of tools: The generation of interface documents with the help of tools usually provides standardized formats for the tools. Users input interface information into the tools, and the tools generate standardized documents based o...

AI Technical Summary

Problems solved by technology

The method of generating interface documents with the help of tools still requires users to manually obtain interface information. For a developed system, developers need to collect the interface information of all interfaces in the system and manually fill in the tool, which is still time-consuming and laborious.

[0005] These traditional methods have the problems of being unable to automatically collect interface information and generating interface documents with low efficiency

Images