A method and device for generating an interface help document

Abstract

The invention discloses a method and device for generating an interface help document, and relates to the technical field of computers. A specific embodiment of the method comprises the steps of obtaining an interface implementation class object of an interface to be called from a context environment of an interface provider according to a preset identifier; and generating an interface help document corresponding to the to-be-called interface based on the interface implementation class object. According to the embodiment, the interface help document can be generated only for the to-be-called interface; the process of generating the interface help document is convenient and fast; and the generated interface helps the document to highlight the key point and protect the internal program at the same time.

Description

technical field [0001] The invention relates to the technical field of computers, in particular to a method and a device for generating interface help files. Background technique [0002] With the rapid development of the business of the enterprise, the content of the business line of the enterprise is also constantly increasing and improving. A complete business line is composed of multiple related application systems. For example, the business line of an enterprise includes accounting system, supply chain management system and personnel management system. The application systems under the same business line need to call the interface. For information transmission and interaction, therefore, the definition information of the interface needs to be fully displayed to the caller. [0003] Usually an application system needs to provide interfaces for multiple other application systems, and the same business operation for different business lines needs to provide a unique inter...

AI Technical Summary

Problems solved by technology

[0006] 1. It is impossible to generate targeted interface help documents. The external interface provided by the application system is only a part of the entire application system, while other parts may be used for internal implementation. If the interface help documents for the entire application system are generated, not only external Exposing the internal structure of the interface provider also interferes with the interface caller;

[0007] 2. It requires a lot of manpower to intervene and the operation is complicated. With the continuous increase or improvement of the business line, the interface will be changed or added accordingly. In order to avoid the mismatch between the interface help document and the interface, whenever the interface changes , it is necessary to regenerate the interface help document of the entire application system

Images