Javadoc-based back-end interface document automatic generation method and apparatus

Abstract

The invention discloses a Javadoc-based back-end interface document automatic generation method. The method specifically comprises the following steps of defining interface information in an interface file; performing description on the interface information by adopting Javadoc: describing code annotation and interface; performing automatic identification by adopting AST code analysis: identifying an input parameter, a return value type, a URL and abnormal data of the interface; and according to a definition of the interface and standard Javadoc, fully automatically generating an interface document. Through the AST code analysis technology, the back-end interface document can be fully automatically generated after all codes are changed in combination with the definition of the interface according to the Javadoc; and front-end codes can be generated according to interface data, so that the problem of desynchrony of the codes and the manually written interface document in the past is solved, the time for writing the interface document is saved, the situation of reworking caused by the problem of desynchrony of the interface document and the codes can be avoided, and the business system development efficiency is improved.

Description

technical field [0001] The invention relates to the field of information technology, in particular to a method and device for automatically generating back-end interface documents. Background technique [0002] In the traditional way, the service interface document is manually written, according to the interface definition, the interface information is manually extracted, the data relationship is manually sorted out, and then according to the interface definition information, one field is extracted and written on the document. Each field needs to indicate the field name, field type, whether the field can be empty, the default value of the field, the sample value of the field, the description of the field, etc. in the document. In addition, fields can be divided into basic data types and complex structures. Complex structures may have multiple layers of nesting, and the depth may be as many as several layers. Interface documentation also needs to include error codes for each...

AI Technical Summary

Problems solved by technology

[0003] In view of the defects in the prior art, one of the purposes of the present invention is to provide a method for automatically generating back-end interface documents based on Javadoc. After all codes are changed, the interface documents can be fully automatically generated, which solves the problem that the past codes and manually written interface documents are out of sync. to improve the efficiency of business system development

Images