API interface development management method and system based on API document

Abstract

The invention relates to the technical field of computers, and discloses an API interface development management method and system based on the API document. The method comprises the steps that a gateway system receives an API document compiled by a user and judges whether the API document meets a compiling standard or not: if yes, the API document is analyzed, an analysis result of the API document is stored, the API document is published to a development side, or else, the API document is marked as an invalid document; after an API interface development result of the development end is received, the gateway system checks the API interface development result according to the stored analysis result of the API document, and if the API interface development result is checked to be qualified,a corresponding API interface is published; if not, prompt information is sent to the development terminal. According to the invention, the API document is managed through the gateway system, the APIdevelopment result is checked and published to realize the automatic deployment of the API interface, and the difficulty of software project development is reduced.

Description

technical field [0001] The invention relates to the field of computer technology, in particular to an API document-based API interface development management method and system. Background technique [0002] With the development of web technology, the separation of front-end and back-end has become a way for more and more Internet companies to build applications. The advantage of the separation of front-end and back-end is that a set of API can be reused by multiple clients, and the division of labor and collaboration are refined, which greatly improves the coding efficiency. However, due to the separation of front-end and back-end, the development results of the back-end are often unreliable, and it is easy to miss the interface of the front-end Need or give the front-end some wrong API interface, this kind of error can only be discovered after the front-end user uses the development results of the back-end, lacking a validity test. And because the API is some pre-defined f...

AI Technical Summary

Problems solved by technology

The advantage of the separation of front-end and back-end is that a set of API can be reused by multiple clients, and the division of labor and collaboration are refined, which greatly improves the coding efficiency. However, due to the separation of front-end and back-end, the development results of the back-end are often unreliable, and it is easy to miss the interface of the front-end Need or give the front-end some wrong API interface, this kind of error can only be discovered after the front-end user uses the development results of the back-end, lacking a validity test

And because the API is some pre-defined functions, once the needs of the front-end users change, it will take energy to modify and update the API interface documents frequently, and the back-end users will not be able to know the updates of the front-end requirements in time, which will easily lead to continuous modification of the back-end development, Rework, resulting in high error rate and low efficiency in the corresponding software interface development process

Therefore, in order to further improve the efficiency of developing software projects, an effective API interface development management method and system for API documentation is urgently needed to solve the problems of unreliable API interface development results and untimely document updates

Images