Interface document generation method and device, electronic equipment and storage medium

Abstract

The invention provides an interface document generation method and a device, electronic equipment and a storage medium. The method is applied to a program code for parameter definition based on a codeannotation of a Swagger. The method comprises the steps: receiving an interface document generation request; determining a target program code according to the interface document generation request,and obtaining a predefined interface document template associated with the target program code; analyzing a code annotation corresponding to the target program code, and obtaining attribute information of the target program code from the code annotation; importing the attribute information into the predefined interface document template to generate an interface document corresponding to the interface document generation request; displaying the interface document. The embodiment of the invention is applied to a program code for parameter definition based on a code annotation of a Swagger, and standardization and universality of the code annotation can be realized; the interface document is automatically generated according to the target program code, and the accuracy of the interface document is improved.

Description

technical field [0001] The invention relates to the field of computer technology, in particular to a method and device for generating an interface document, electronic equipment, and a storage medium. Background technique [0002] In today's Internet era, the information system supports the operation of online services. The interaction between the front-end service and the back-end service in the information system and the interaction between the information systems are all communicated through API (Application Programming Interface, Application Programming Interface). Currently the most popular web data interface design specification is RESTful (Representational State Transfer, representational state transfer), and in the current microservice model, there are more and more domains divided according to business, and each domain is physically independent of each other. There are more and more APIs for communication between RESTful APIs, so the RESTful API is the skeleton of t...

AI Technical Summary

Problems solved by technology

[0003] In the existing technology, the maintenance method of the API interface is carried out through Excel. Due to the complexity of the actual business and the change of the requirements in the development process, the API definition will be changed, and the work saturation of the developers is very high. Progress, modify the API directly in the program, and maintain the changes of the API in the document in real time, which is a very complicated and time-consuming task

Therefore, as the system development progresses, the final program implementation often differs greatly from the initially defined API, which causes great difficulties for other personnel in the later system maintenance stage or when work is handed over. When the system communicates, the API interface documentation provided is usually not accurate, which seriously affects the work efficiency of both parties

Images