Interface document generation method and device and computer readable storage medium

Abstract

The invention relates to the technical field of data processing, and discloses an interface document generation method and device and a computer readable storage medium. The method comprises the following steps of: if a request for accessing a first interface document of a first interface is received, obtaining first interface data corresponding to the first interface, wherein the first interfacedata is generated according to an annotated first interface program; analyzing the first interface data to obtain attribute information of the first interface; and correspondingly adding the attributeinformation of the first interface to a preset interface document template to obtain the first interface document, and displaying the first interface document. According to the method and device andthe computer readable storage medium, the manpower is saved, the generated interface documents are uniform in format so that other developers can read conveniently, and consistency between the interface documents and interface attributes can be ensured at the same time.

Description

technical field [0001] The present invention relates to the technical field of data processing, in particular to a method, device and computer-readable storage medium for generating an interface document. Background technique [0002] The communication rules between different functional layers of the same system are called interfaces. The interface document is used to describe the properties of the interface, such as describing the format of the input parameters of the interface, the format of the output parameters, or the communication protocol. Usually, after an interface is developed, the developer will write an interface document corresponding to the interface, so that other developers can clearly understand the corresponding interface through the interface document. [0003] The existing interface documents need to be written by developers themselves, which is time-consuming and labor-intensive; and the format of interface documents written by different developers is n...

AI Technical Summary

Problems solved by technology

[0004] Embodiments of the present invention provide a method, device, and computer-readable storage medium for generating interface documents, aiming to solve the time-consuming and labor-intensive existing methods of manually writing interface documents, and the formats of interface documents written by different developers are not uniform , the problem that the interface document is inconsistent with the interface attribute

Images