CN113741893A - JSON (Java Server object notation) -analysis-based open platform interface document automatic generation method and system - Google Patents

Abstract

The invention relates to a JSON analysis-based open platform interface document automatic generation method and a system, wherein the method comprises the following steps: step A: the JSON source data system generates JSON data of an interface document; and B: the JSON analysis engine analyzes JSON data of the interface document and generates final data of the interface document; and C: the interface document management system checks the integrity and the legality of the final data of the interface document, and if the check is passed, the step D is executed; step D: the interface document management system stores the interface document final data that passes the verification. The invention has the advantages that: the invention realizes the automatic generation of the interface document based on the JSON analysis mode, so that the automatic generation technology of the interface document is more universal. The method and the device have the advantages that the generated final data of the interface document is stored persistently, the document is ensured not to be lost easily, and the guarantee is provided for software development. The automatic generation technology of the interface document provided by the invention reduces manual intervention, improves the accuracy of the interface document and improves the efficiency of software development.

Description

JSON (Java Server object notation) -analysis-based open platform interface document automatic generation method and system

Technical Field

The invention belongs to the technical field of computers, and particularly relates to a JSON (Java Server pages open platform) analysis-based open platform interface document automatic generation technology.

Background

With the continuous development of the internet, in the current internet era, the technical openness of packaging a series of services as data interfaces is opened and becomes a future strategy of each large internet company, internet factories open their own technologies for third-party developers to use, the third-party developers develop various rich and colorful applications based on the open interface capabilities, the third-party developers need to provide corresponding interface documents to know the developers to call when calling the interfaces, and then, a large amount of human resources are consumed for writing and maintaining the interface documents.

Chinese patent publication No. CN110244945A discloses a technique entitled "interface document generation method and terminal device", which does not involve parsing an interface document and generating interface document final data.

Chinese patent publication No. CN110806863A discloses a technique entitled "an interface document generation method and apparatus, electronic device, and storage medium", which generates an interface document based on Swagger and program code techniques, and which depends on program codes and is poor in versatility.

Disclosure of Invention

The invention aims to provide a JSON (Java Server pages open platform) analysis-based method and a JSON analysis-based system for automatically generating an open platform interface document, which solve the technical problems that: there is no general automatic generation technology of interface documents.

In order to solve the technical problems, the invention adopts the following technical scheme: a JSON analysis-based open platform interface document automatic generation method comprises the following steps:

step A: the JSON source data system generates JSON data of an interface document;

and B: the JSON analysis engine analyzes the JSON data of the interface document and generates final data of the interface document;

and C: the interface document management system checks the integrity and the legality of the final data of the interface document, and if the check is passed, the step D is executed;

step D: the interface document management system stores the verified interface document final data.

Preferably, in the step a, the interface document JSON data includes an interface name, an interface classification, an interface basic path, an interface request method, an interface request parameter, return data, a tag, and a state; the interface request method comprises GET and POST; the status includes completed and not completed.

Preferably, when the interface request method is GET, the interface request parameter is Query parameter; and when the interface request method is POST, the interface request parameter is Body parameter.

Preferably, the JSON source data system transmits the JSON data of the interface document to the JSON parsing engine in an API manner.

Preferably, in the step B, the JSON parsing engine checks whether the JSON data of the interface document is normal and complete, and when the JSON data of the interface document passes the check, the JSON parsing engine parses each field of the JSON data of the interface document according to the request header parameter, the request parameter, and the response parameter.

Preferably, the parameter attributes obtained after the JSON data of the interface document is parsed by the JSON parsing engine include type, whether to fill, description, and example values.

Preferably, in the step D, the interface document management system presents the interface document final data in the form of a front end H5 page.

The invention also provides a JSON analysis-based open platform interface document automatic generation system, which comprises:

the JSON source data system is used for providing interface document JSON data which conforms to the specification;

the JSON analysis engine is used for analyzing the JSON data of the interface document and generating final data of the interface document;

and the interface document management system is used for storing the final data of the interface document.

By adopting the technical scheme, the beneficial technical effects of the invention are as follows: JSON is a light-weight data exchange format, easy to read and write by people, and easy to analyze and generate by a machine, JSON adopts a text format completely independent of languages, also uses habits similar to a C language family, supports multiple languages, including ActionScript, C #, ColdFusion, Java, JavaScript, Perl, PHP, Python, Ruby and other language server-side languages, and is convenient for analyzing the server side. The method and the device have the advantages that the generated final data of the interface document is stored persistently, the document is ensured not to be lost easily, and the guarantee is provided for software development. The automatic generation technology of the interface document provided by the invention reduces manual intervention, improves the accuracy of the interface document and improves the efficiency of software development.

Drawings

FIG. 1 is an overall architecture diagram of the present invention;

FIG. 2 is an overall flow chart of the present invention;

FIG. 3 is a management interface for a zone and a fence;

FIG. 4 is a new add/edit zone interface;

FIG. 5 is a new fence interface;

FIG. 6 is a diagram illustrating a request header parameter, a request parameter and a response parameter according to the present invention.

Detailed Description

The invention will be further explained with reference to the drawings.

As shown in FIG. 1 and FIG. 2, the present invention provides a JSON parsing-based open platform interface document automatic generation method, firstly, JSON source data system must be used to generate interface document JSON data, the interface document JSON data includes interface name, interface classification, interface basic path, interface request method, interface request parameter, return data, tag and state, the interface request method includes GET and POST, and the state includes completed and incomplete. When the request method is GET, the interface request parameter is Query parameter, and when the interface request method is POST, the interface request parameter is Body parameter. As shown in fig. 3, 4 and 5, the generation of the JSON data in the interface document is that a developer can generate JSON data in the interface document by option operation at the front end of the JSON source data system, basic information such as an interface name, an interface classification, an interface basic path and the like is written in the front end interface of the JSON source data system, and an interface request method such as GET, POST and the like is further edited at the interface basic path. Other details of the interface may be edited under a particular page.

The written content can still be edited again under a specific page, and the 'tag' and the 'state' can be edited, the 'tag' can be set as the 'tag', and the 'state' can be selected as 'completed' or 'not completed', so that whether the interface is developed or not is indicated. After the content is edited again, the interface request parameters and the return data can be edited on the page, wherein the editing interface of the request parameters can be changed according to different interface request methods, and parameters in Query can be edited if the request mode is GET; when the request mode is POST, the parameters in Body can be edited, after the editing of the request parameters is completed, the returned data is edited, and the editing is performed according to the concrete actual correspondence of the interface.

The method comprises the steps that after a developer completes writing of the contents of an interface document in a JSON source data system, interface document JSON data are generated, the JSON source data system converts the interface document JSON data into the interface document JSON data, the JSON source data system sends the interface document JSON data to a JSON analysis engine in an API mode, the JSON analysis engine analyzes the interface document JSON data, whether the interface document JSON data meet JSON specifications or not is firstly checked, each field in the interface document JSON data is verified, and whether the interface document JSON data are completed or not is checked. After the JSON data of the interface document passes the verification, the JSON analysis engine respectively analyzes each field in the JSON data of the interface document according to three plates of a request header parameter, a request parameter and a corresponding parameter, and analyzes the type, the filling, the description, the example value and other attributes of each parameter in a JSON analysis mode to finally generate the final data of the interface document.

The interface document management system checks the integrity and the legality of the final data of the interface document, and if the check is passed, the interface document management system stores the final data of the interface document passing the check and displays the final data of the interface document in a front-end H5 page form.

Claims (8)

1. A JSON analysis-based open platform interface document automatic generation method is characterized by comprising the following steps:

step A: the JSON source data system generates JSON data of an interface document;

and B: the JSON analysis engine analyzes the JSON data of the interface document and generates final data of the interface document;

and C: the interface document management system checks the integrity and the legality of the final data of the interface document, and if the check is passed, the step D is executed;

step D: the interface document management system stores the verified interface document final data.

2. The method for automatically generating an open platform interface document based on JSON (java server object notation) parsing of claim 1, wherein in the step A, JSON data of the interface document comprises an interface name, an interface classification, an interface basic path, an interface request method, an interface request parameter, return data, tag and a state; the interface request method comprises GET and POST; the status includes completed and not completed.

3. The JSON-parsing-based open platform interface document automatic generation method according to claim 2, wherein when the interface request method is GET, the interface request parameter is Query parameter; and when the interface request method is POST, the interface request parameter is Body parameter.

4. The method for automatically generating an open platform interface document based on JSON parsing of claim 1, wherein the JSON source data system transmits JSON data of the interface document to the JSON parsing engine in an API manner.

5. The method for automatically generating an open platform interface document based on JSON parsing of claim 1, wherein in the step B, the JSON parsing engine checks whether the JSON data of the interface document is normal and complete, and when the JSON data of the interface document passes the check, the JSON parsing engine parses each field of the JSON data of the interface document according to a request header parameter, a request parameter and a response parameter.

6. The method for automatically generating the open platform interface document based on the JSON parsing of claim 5, wherein the parameter attributes obtained after the JSON data of the interface document is parsed by the JSON parsing engine include type, whether to fill in, description and example values.

7. The method for automatically generating an open platform interface document based on JSON parsing as claimed in claim 1, wherein in the step D, the interface document management system exposes the final data of the interface document in a front end H5 page form.

8. A JSON analysis-based open platform interface document automatic generation system is characterized by comprising:

the JSON source data system is used for providing interface document JSON data which conforms to the specification;

the JSON analysis engine is used for analyzing the JSON data of the interface document and generating final data of the interface document;

and the interface document management system is used for storing the final data of the interface document.

Images