CN107872484B - REST API rapid registration method, device and system - Google Patents

REST API rapid registration method, device and system Download PDF

Info

Publication number
CN107872484B
CN107872484B CN201610855017.4A CN201610855017A CN107872484B CN 107872484 B CN107872484 B CN 107872484B CN 201610855017 A CN201610855017 A CN 201610855017A CN 107872484 B CN107872484 B CN 107872484B
Authority
CN
China
Prior art keywords
api
rest
parameter
request
rest api
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Active
Application number
CN201610855017.4A
Other languages
Chinese (zh)
Other versions
CN107872484A (en
Inventor
何震苇
李蓉蓉
杨新章
周荣生
梁柏青
陆钢
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
China Telecom Corp Ltd
Original Assignee
China Telecom Corp Ltd
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by China Telecom Corp Ltd filed Critical China Telecom Corp Ltd
Priority to CN201610855017.4A priority Critical patent/CN107872484B/en
Publication of CN107872484A publication Critical patent/CN107872484A/en
Application granted granted Critical
Publication of CN107872484B publication Critical patent/CN107872484B/en
Active legal-status Critical Current
Anticipated expiration legal-status Critical

Links

Images

Classifications

    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L69/00—Network arrangements, protocols or services independent of the application payload and not provided for in the other groups of this subclass
    • H04L69/22—Parsing or analysis of headers
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F9/00—Arrangements for program control, e.g. control units
    • G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
    • G06F9/46—Multiprogramming arrangements
    • G06F9/54—Interprogram communication
    • G06F9/547—Remote procedure calls [RPC]; Web services
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L41/00—Arrangements for maintenance, administration or management of data switching networks, e.g. of packet switching networks
    • H04L41/08—Configuration management of networks or network elements
    • H04L41/0803—Configuration setting
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L65/00—Network arrangements, protocols or services for supporting real-time applications in data packet communication
    • H04L65/1066—Session management
    • H04L65/1073—Registration or de-registration
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L67/00—Network arrangements or protocols for supporting network services or applications
    • H04L67/50—Network services
    • H04L67/60—Scheduling or organising the servicing of application requests, e.g. requests for application data transmissions using the analysis and optimisation of the required network resources
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F2209/00—Indexing scheme relating to G06F9/00
    • G06F2209/54—Indexing scheme relating to G06F9/54
    • G06F2209/541—Client-server

Landscapes

  • Engineering & Computer Science (AREA)
  • Computer Networks & Wireless Communication (AREA)
  • Signal Processing (AREA)
  • Theoretical Computer Science (AREA)
  • Software Systems (AREA)
  • Multimedia (AREA)
  • General Business, Economics & Management (AREA)
  • Business, Economics & Management (AREA)
  • Physics & Mathematics (AREA)
  • General Engineering & Computer Science (AREA)
  • General Physics & Mathematics (AREA)
  • Computer Security & Cryptography (AREA)
  • Data Exchanges In Wide-Area Networks (AREA)

Abstract

The invention discloses a rapid registration method, a rapid registration device and a rapid registration system for REST API. The method comprises the following steps: the API registry device receives basic information of a representational state transfer REST application programming interface API input by a user; the API resolver extracts a parameter list and a calling example of the REST API from a request packet and a response packet of the REST API so as to complete the registration process of the whole REST API. According to the invention, the input/output parameters and the call request/response examples of the API are extracted from the REST API request and response data packet, so that the fussy parameter and example entry process is avoided, and the flexible, quick and consistent REST API registration management is realized.

Description

REST API rapid registration method, device and system
Technical Field
The invention relates to the field of interface opening in the field of mobile internet, in particular to a RESTAPI quick registration method, a device and a system.
Background
A REST (Representational State Transfer) API (Application Programming Interface) is a lightweight service Interface based on HTTP (HyperText Transfer Protocol), and has become a mainstream Interface form of each large open platform.
The REST API can be opened to the outside only by registering and releasing in an open platform for a third party to view and call, and the REST API registration management method in the prior art as shown in fig. 1 has some problems and is difficult to adapt to the requirement of rapid increase of the API number in the era of API economy.
Adopting a manual registration mode: manually inputting each item of information of the REST API one by one, including a URL (Uniform Resource Locator), an interface parameter, a calling example, etc., a complex API has a large number of input and output parameters, and the manual input is all relied on, so that the efficiency is low and errors are easy to occur.
Adopting an API model import mode: API registration is achieved by importing a predefined REST API description model. However, most of the REST APIs are not modeled, a model script needs to be written for the APIs before registration, extra API model editing and maintenance workload is needed, and the three API description models (Swagger, API, and RAML) are not perfect at present, and cannot describe all REST API forms, for example, none of the three support the emerging YAML (Yet other Markup Language) data format and Token data type, only the RAML supports the XML (Extensible Markup Language), and the flexibility of the registration mode based on the API model is poor.
Disclosure of Invention
In view of the above technical problems, the present invention provides a rapid REST API registration method and system, an API registry apparatus, a test API gateway, and an API interface parser, which achieve flexible, rapid, and consistent REST API registration management.
According to an aspect of the present invention, a rapid REST API registration method is provided, including:
the API registry device receives basic information of a representational state transfer REST application programming interface API input by a user;
the API resolver extracts a parameter list and a calling example of the REST API from a request packet and a response packet of the REST API so as to complete the registration process of the whole REST API.
In one embodiment of the present invention, the basic information of the representational state transfer REST application programming interface API, which is input by the user, received by the API registry apparatus includes:
the method comprises the following steps that an API registry device receives basic information of REST API input by a user;
the API registry device sends the basic information of the REST API to the test API gateway;
and the test API gateway creates an API front-end service port according to the basic information and binds an API rear-end server.
In one embodiment of the invention, the API interface parser extracting the parameter list and call examples of the REST API from the request packet and the response packet of the REST API includes:
the method comprises the steps that a test API gateway receives an RESTAPI request packet sent by an API provider by using an API test client;
the test API gateway forwards the REST API request packet to a back-end API server bound with a front-end API port and an API interface resolver;
the API parser parses out a parameter list and a call instance from the REST API request packet, wherein the parameter list includes request parameters and the call instance includes a request instance.
In an embodiment of the present invention, the extracting the parameter list and the call example of the REST API from the request packet and the response packet of the REST API further includes:
the back-end API server processes the REST API request and returns a REST API response packet to the test API gateway;
the test API gateway forwards the REST API response packet to an API interface resolver;
the API parser parses out a parameter list and a call instance from the REST API response packet, wherein the parameter list includes response parameters and the call instance includes a response instance.
In one embodiment of the present invention, the step of the API interface parser extracting the parameter list of the REST API from the request packet and the response packet of the REST API includes:
and analyzing the data in YAML, XML and JSON data formats in the REST API request packet and the response packet.
In one embodiment of the present invention, the step of the API interface parser extracting the parameter list of the REST API from the request packet and the response packet of the REST API includes:
performing multiple times of parameter analysis on multiple REST API requests in the REST API request process and multiple times of REST API responses in the REST API response process;
and summarizing the parameter analysis results for multiple times, and determining a final parameter list of the REST API.
In an embodiment of the present invention, the aggregating the results of the multiple parameter resolutions and determining a final parameter list of the REST API includes:
summarizing the URL template and the Path parameter result in the multiple parameter analysis results, and determining the final URL template and Path parameter;
summarizing the parameter types of Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters;
summarizing the parameters of the HttpStatus Code and the Status Message responded by the API in the multiple parameter analysis results, and determining the final parameter values of the HttpStatus Code and the Status Message.
In one embodiment of the invention, the method further comprises:
the API interface parser writes the parameter list and call instances to an API registry.
In one embodiment of the invention, the method further comprises:
after receiving a modification instruction of a user, the API registry device deletes and modifies the parameter list and the calling example;
and/or the presence of a gas in the gas,
after receiving a confirmation instruction of a user, the API registry device issues API registration information to a formal API gateway so that a third party application can call an REST API through the formal API gateway;
and/or the presence of a gas in the gas,
and after receiving an API registration information viewing request sent by a developer through the API portal website, the API registry device sends the registration information of the REST API to the API portal website so as to facilitate the developer to view.
According to another aspect of the present invention, there is provided an API registry apparatus including a basic information receiving module, a basic information transmitting module, and a parameter list receiving module, wherein:
the basic information receiving module is used for receiving basic information of a representational state transfer REST application programming interface API input by a user;
the basic information sending module is used for sending the basic information of the REST API to the test API gateway so that a REST API request packet and a response packet of the test API gateway can be forwarded to the API interface resolver;
and the parameter list receiving module is used for receiving the parameter list and the calling example which are analyzed from the REST API request packet and the response packet by the API parser so as to complete the registration process of the whole REST API.
In an embodiment of the present invention, the API registry apparatus further includes at least one of a parameter modification module, a registration information publishing module and a registration information presenting module, wherein:
the parameter modification module is used for deleting and modifying the parameter list and the calling example after receiving a modification instruction of a user;
the registration information issuing module is used for issuing API registration information to the formal API gateway after receiving a confirmation instruction of a user so that a third party application can call RESTAPI through the formal API gateway;
and the registration information presentation module is used for sending the registration information of the REST API to the API portal website after receiving an API registration information viewing request sent by a developer through the API portal website so as to facilitate the developer to view.
According to another aspect of the present invention, there is provided a test API gateway, including a service port creation module, a request receiving module, and a request forwarding module, wherein:
the service port creating module is used for receiving basic information of the representational state transfer (REST) API sent by the API registry device, creating an API front-end service port according to the basic information and binding an API rear-end server;
the request receiving module is used for receiving a REST API request packet sent by an API provider by utilizing an API test client;
and the request forwarding module is used for forwarding the REST API request packet to a back-end API server bound with a front-end API port and an API (application programming interface) parser, so that the API parser parses a parameter list and a calling example from the REST API request packet and writes the parameter list and the calling example into an API registry, wherein the parameter list comprises request parameters, and the calling example comprises a request example.
In one embodiment of the present invention, the test API gateway further includes a response receiving module and a response forwarding module, wherein:
the response receiving module is used for receiving a REST API response packet returned after the REST API request is processed by the back-end API server;
and the response forwarding module is used for forwarding the REST API response packet to the API interface parser so that the API interface parser parses a parameter list and a calling example from the REST API request packet and writes the parameter list and the calling example into the API registry, wherein the parameter list further comprises response parameters, and the calling example further comprises a response example.
According to another aspect of the present invention, there is provided an API interface parser, comprising a packet receiving module, a packet parsing module, and a parameter writing module, wherein:
the system comprises a data packet receiving module, a testing API gateway and a state transfer REST Application Programming Interface (API) parser, wherein the data packet receiving module is used for receiving an API request packet of a representational state transfer (REST) application programming interface forwarded by the testing API gateway, and the testing API gateway forwards the REST API request packet to a back-end API server bound with a front-end API port and the API parser when receiving the REST API request packet sent by an API provider by utilizing an API testing client;
the data packet analysis module is used for analyzing a parameter list and a calling example from a REST API request packet, wherein the parameter list comprises request parameters, and the calling example comprises the request example;
and the parameter writing module is used for writing the parameter list and the calling example into the API registry.
In an embodiment of the present invention, the data packet receiving module is further configured to test a REST API response packet forwarded by the API gateway, where the test API gateway forwards the REST API response packet to the API interface parser when receiving the REST API response packet returned by the back-end API server after processing the REST API request; the data packet analysis module is further configured to analyze a parameter list and a call example from the REST API request packet, where the parameter list further includes a response parameter, and the call example further includes a response example.
In an embodiment of the present invention, the data packet parsing module is configured to parse data in YAML, XML, and JSON data formats in a REST API request packet or a REST API response packet.
In an embodiment of the invention, the data packet analysis module is used for carrying out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple RESTAPI responses in the REST API response process; and summarizing the parameter analysis results for multiple times, and determining a final parameter list of the REST API.
In an embodiment of the invention, the data packet parsing module is used for summarizing the URL template and the Path parameter result in the parameter parsing results for multiple times, and determining the final URL template and Path parameter; summarizing the parameter types of Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters; summarizing the parameters of the HttpStatus Code and the Status Message responded by the API in the multiple parameter analysis results, and determining the final parameter values of the HttpStatus Code and the Status Message.
According to another aspect of the present invention, there is provided a REST API fast registration system, including the API registry apparatus according to any of the above embodiments, the test API gateway according to any of the above embodiments, and the API interface parser according to any of the above embodiments.
According to the invention, the input/output parameters and the call request/response examples of the API are extracted from the REST API request and response data packet, so that the fussy parameter and example entry process is avoided, and the flexible, quick and consistent REST API registration management is realized.
Drawings
In order to more clearly illustrate the embodiments of the present invention or the technical solutions in the prior art, the drawings used in the description of the embodiments or the prior art will be briefly described below, it is obvious that the drawings in the following description are only some embodiments of the present invention, and for those skilled in the art, other drawings can be obtained according to the drawings without creative efforts.
Fig. 1 is a schematic diagram of a REST API registration management method in the prior art.
FIG. 2 is a diagram illustrating an embodiment of a REST API rapid registration system according to the present invention.
Fig. 3 is a diagram illustrating a quick registration method for REST APIs according to a first embodiment of the present invention.
Fig. 4a to fig. 4c are schematic diagrams of a REST API fast registration method according to a second embodiment of the present invention.
FIG. 5 is a diagram illustrating an API registry apparatus according to a first embodiment of the present invention.
FIG. 6 is a diagram illustrating an API registry apparatus according to a second embodiment of the present invention.
FIG. 7 is a diagram of a test API gateway according to a first embodiment of the present invention.
FIG. 8 is a diagram of a second embodiment of a test API gateway in accordance with the present invention.
FIG. 9 is a diagram illustrating an embodiment of an API interface parser in accordance with the present invention.
Fig. 10 is a diagram illustrating a packet parsing module according to an embodiment of the invention.
Detailed Description
The technical solutions in the embodiments of the present invention will be clearly and completely described below with reference to the drawings in the embodiments of the present invention, and it is obvious that the described embodiments are only a part of the embodiments of the present invention, and not all of the embodiments. The following description of at least one exemplary embodiment is merely illustrative in nature and is in no way intended to limit the invention, its application, or uses. All other embodiments, which can be derived by a person skilled in the art from the embodiments given herein without making any creative effort, shall fall within the protection scope of the present invention.
The relative arrangement of the components and steps, the numerical expressions and numerical values set forth in these embodiments do not limit the scope of the present invention unless specifically stated otherwise.
Meanwhile, it should be understood that the sizes of the respective portions shown in the drawings are not drawn in an actual proportional relationship for the convenience of description.
Techniques, methods, and apparatus known to those of ordinary skill in the relevant art may not be discussed in detail but are intended to be part of the specification where appropriate.
In all examples shown and discussed herein, any particular value should be construed as merely illustrative, and not limiting. Thus, other examples of the exemplary embodiments may have different values.
It should be noted that: like reference numbers and letters refer to like items in the following figures, and thus, once an item is defined in one figure, further discussion thereof is not required in subsequent figures.
FIG. 2 is a diagram illustrating an embodiment of a REST API rapid registration system according to the present invention. As shown in fig. 2, the REST API fast registration system includes an API registry apparatus 1, a test API gateway 2, and an API interface resolver 3.
The API registry apparatus 1 is configured to receive basic information, such as an API name and a URL, of the representational state transfer REST application programming interface API input by the user, and send the basic information of the REST API to the test API gateway 2.
A test API gateway 2, which is used for receiving the basic information of the REST API sent by the API registry device 1; creating an API front-end service port according to the basic information, and binding an API rear-end server; receiving a REST API request packet sent by an API provider by utilizing an API test client; and forwarding the REST API request packet to a back-end API server bound with a front-end API port and an API interface resolver 3.
The API resolver 3 is used for receiving the REST API request packet forwarded by the test API gateway 2; analyzing a parameter list and a calling example from a REST API request packet, wherein the parameter list comprises request parameters, and the calling example comprises a request example; and writing the parameter list and the calling example into an API registry.
Based on the REST API rapid registration system provided by the embodiment of the invention, aiming at the problems of low efficiency, error proneness, poor flexibility and the like existing in the current REST API registration management, the REST API registration information is divided into two parts of contents of manual entry and automatic generation, the basic information of an API name, a URL and the like is entered manually, and then the parameter list and the calling example of the REST API are automatically extracted from the request data packet of the REST API, so that the registration process of the whole REST API is completed, and the flexible, rapid and consistent REST API registration management is realized.
In an embodiment of the present invention, the test API gateway 2 may be further configured to receive a REST API response packet returned by the back-end API server after processing the REST API request; the REST API response packet is forwarded to the API interface parser 3.
The API interface parser 3 may be further configured to parse a parameter list and a call example from the REST API request packet, and write the parameter list and the call example into the API registry, where the parameter list further includes a response parameter, and the call example further includes a response example.
The embodiment of the invention can extract the input/output parameters and the call request/response examples of the API from the REST API request and response data packet, thereby avoiding the fussy parameter and example entry process and improving the registration efficiency of the REST API. In the above embodiments of the present invention, the registration parameters and the call examples of the open interface directly originate from real API calls, thereby ensuring the consistency between the open API interface and the back-end API.
Fig. 3 is a diagram illustrating a quick registration method for REST APIs according to a first embodiment of the present invention. Preferably, this embodiment can be performed by the REST API fast registration system of the present invention. The fig. 3 embodiment may include:
in step 31, the API registry apparatus 1 receives basic information of the representational state transfer REST application programming interface API input by the user.
Step 32, the API interface parser 3 extracts the parameter list and the call example of the REST API from the REST API request packet sent by the test application to the API server through the test API gateway and the response packet returned by the API server, so as to complete the registration process of the whole REST API.
In one embodiment of the invention, input/output parameters of the API are extracted from the REST API request and response data packet, wherein the input/output parameters comprise parameter names and parameter types of input and output parameters, and the parameter types support numbers, Boolean, dates, character strings, arrays and objects.
The REST API rapid registration method provided by the embodiment of the invention is an REST API rapid registration method based on API communication packet analysis, and aims at the problems of low efficiency, error easiness, poor flexibility and the like existing in the current REST API registration management, the REST API registration information is divided into two parts of contents of manual entry and automatic generation, basic information such as API names and URLs is entered manually, and then the parameter list and the calling example of the REST API are automatically extracted from the request data packet of the REST API to complete the whole REST API registration process, so that the flexible, rapid and consistent REST API registration management is realized.
In one embodiment of the invention, the extracted REST API request and response package may serve as a call request and response instance of the API document.
In the above embodiments of the present invention, the registration parameters and the call examples of the open interface directly originate from real API calls, and the API registration is combined with the API test, so as to ensure the consistency between the open API interface and the API implementation.
In one embodiment of the invention, an extensible parameter interpreter is provided for each parameter model (Path, Query, Header, Body) of the REST API, supporting arbitrary parameter combination collocation. Therefore, the embodiment of the invention can flexibly adapt to various REST API forms.
In one embodiment of the present invention, the method may further include: and automatically updating the API registration information and the API document information according to the change of the API request and the response data, and automatically managing the version change of the API registration information. Therefore, the embodiment of the invention further improves the intelligent degree of API registration and management and improves the user experience.
Fig. 4a to fig. 4c are schematic diagrams of a REST API fast registration method according to a second embodiment of the present invention. Preferably, this embodiment can be performed by the REST API fast registration system of the present invention. The fig. 4a embodiment may include:
step 41, firstly, manually adding basic information of the REST API to an API registry, where the basic information of the API includes:
API name: such as sending a short message.
Front end URL prefixes, for example: and/api/1.0/app.
Backend URL prefixes, for example: http:// 10.10.10.10/app.
The Http method, for example: and (6) post.
Step 42, the API registry apparatus issues an API front-end URL entry to the test API gateway, and may send the basic information of the API to the test API gateway by using an RPC (Remote Procedure Call Protocol) Call or event push manner.
And 43, the API testing gateway creates an API front-end service port according to the API basic information, wherein the URL of the API front end is the domain name of the API testing gateway plus the prefix of the front URL, such as http:// testapi.
Step 44, the API provider sends an RESTAPI request to the test API gateway by using the API test client, the test API gateway forwards the API request to a back-end API server bound with the front-end API port, and the back-end API server processes the API request and returns an API response to the API test gateway. The API request and the API response are packaged by a standard HTTP request and response packet, wherein the position of the parameter of the API request in the HTTP request packet can be Path, Query, HTTP header or HTTP body, and the position of the response parameter can be StatusCode, HTTP header or HTTP body.
And step 45, the test API gateway forwards the API request packet and the response packet to the API interface resolver.
Step 46, the API interface parser parses API request parameters (parameter name, parameter type) from the request packet, parses response parameters from the response packet, and writes the parsed request parameters, response parameters, and request and response instances into the registry entry of the API.
In one embodiment of the present invention, in step 46 in the embodiment of fig. 4a, the step of the API interface parser parsing the API request parameters from the request packet or parsing the response parameters from the response packet may include: and analyzing the data in YAML, XML and JSON data formats in the REST API request packet or the REST API response packet. For example: the data in different data formats such as YAML, XML, JSON and the like in the Body parameter in the REST API request packet or the REST API response packet can be analyzed.
In an embodiment of the present invention, as shown in fig. 4b, in step 46 in the embodiment of fig. 4a, the step of the API interface parser parsing the API request parameters from the request packet or parsing the response parameters from the response packet may include:
step 461, performing multiple parameter analyses on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process.
Step 462, summarize the multiple parameter resolution results, and determine the final parameter list of the REST API.
In one embodiment of the present invention, as shown in fig. 4c, step 462 in the embodiment of fig. 4b may include:
step 4621, summarize the URL templates and Path parameter results in the multiple parameter parsing results, and determine the final URL templates and Path parameters.
For example: by collecting URL values multiple times:
/api/1.0/app/123/category/456；
/api/1.0/app/189/category/4930；
the URL template may be determined to be: /{ api/1.0/app/{ path1}/category/{ path2 }.
The URL template consists of URL prefix (/ api/1.0/app /), path constant (category) and path parameter (path1, path 2). The path constant is constant over multiple requests, and the path parameter has at least two different values over multiple requests.
Step 4622, summarizing the parameter types of the Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters.
For example: the Path, Query, Header and Body parameters can identify the parameter types, and the supported parameter types are as follows: integer, floating point, boolean, date, string, array, object. The integer, floating point number, Boolean and date belong to the precise type, and when encountering the character string value, the integer, floating point number, Boolean and date are converted into the character string type.
Step 4623, summarizing the http Status Code and Status Message parameters of the API response in the multiple parameter analysis results, and determining the final http Status Code and Status Message parameter values. Wherein the http Status Code and Status Message parameters in the API response appear in pairs.
For example, if the first analyzed http Status Code and Status Message parameter values are 200A, and the second analyzed http Status Code and Status Message parameter values are 200B, the final http Status Code and Status Message parameter values are updated to the second analyzed values, that is, the http Status Code and Status Message parameter values are based on the last analyzed value.
And step 47, the API provider can delete parameters and examples which are not required to be published, and publish the API to the formal API gateway after confirming the API registration information.
And step 48, the developer checks the API registration information through the API portal, and the third-party application calls the REST API through the formal API gateway.
Aiming at the problems of low efficiency, error proneness, poor flexibility and the like of the current REST API registration management method, the method of the embodiment of the invention automatically extracts the interface information of the REST API from the request and response data packet of the REST API, thereby simplifying the registration process of the REST API and improving the registration efficiency of the REST API. The method of the embodiment of the invention combines the registration process of the API with the test process of the API, so that the registration information of the API is consistent with the back end of the API, thereby improving the quality of the registration information of the REST API.
The embodiment of the invention can realize the analysis of the data with different data formats such as YAML, XML, JSON and the like.
The embodiment of the invention can carry out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process, and summarize the multiple parameter analysis results to determine the final parameter list of the REST API. Therefore, the embodiment of the invention improves the instruction for analyzing the API parameters, thereby further improving the quality of the REST API registration information.
How the API interface parser performs the request parameter parsing in step 46 according to the above embodiment of the present invention is described below by using specific examples.
Firstly, request parameter analysis example:
POST/api/1.0/app/3065HTTP/1.1
Accept:application/json；
Content-Type:application/json
Authorization:f2s3d1ad13c4d32fas3d15ac3d13c4d32
Content-Length:72
{"appName":"TestApp","appType":1,"appState":0,"desc":"It'sa test app"}
for the request data packet, the parameter analyzing step is as follows:
step 0, assume that the URL prefix of the API published at the test API gateway is "/API/1.0/app/".
Step 1, analyzing HttpMethod, namely the first word of the request packet, and obtaining POST.
And 2, analyzing the Path parameter list. After extracting the URL prefix to'? ' (i.e., Query parameter) or the content between spaces, the Path parameter is named Path1, Path2., in turn, resulting in Path [ { "Path1", "integrator", "3065" }.
And 3, analyzing the Query parameter list. Extract URL? The latter content, in this case empty.
Step 4, analyzing the http header parameter list to obtain:
HttpHeaders:[{"Accept","string","application/json"},
{"Content-Type","string","application/json"},
{"Authorization","string","f2s3d1ad13c4d32fas3d15ac3d13c4d32"},
{"Content-Length","Integer",72}
]
and 5, filtering standard http header (the standard http header list can be predefined), wherein Accept, Content-Type and Content-Length are standard http headers, and obtaining an APIHheader list after filtering.
APIHeaders:[{"Authorization","string","f2s3d1ad13c4d32fas3d15ac3d13c4d32"}]
6. Resolving the Body parameter.
a) And if the Content-Type is application/JSON, executing a JSON (JavaScript object notation) parser, and performing JSON parsing on the body parameter.
b) And if the Content-Type is application/XML, executing an XML parser to perform XML parsing on the body parameter.
c) If the Content-Type is application/x-YAML, then YAML parser is executed to YAML parse the body parameter.
This example performs json analysis to obtain the following Body parameters:
Figure BDA0001121349320000141
for the request data packet of the present invention, the following request parameter list can be obtained finally:
Figure BDA0001121349320000142
Figure BDA0001121349320000151
second, response parameter parsing example
HTTP/1.1 200OK
Content-Type:application/json；charset-UTF-8
{"appId":1,"appName":"TestApp","appType":1,"appState":0,"desc":"It's a test app"}
For the response data packet, the parameter analyzing step is as follows:
and step 1, analyzing StatusCode and Message of Http, which are 200 and OK.
And step 2, analyzing the http parameter list in a manner similar to the http parameter analysis of the request.
And 3, resolving the Body parameter in a similar manner to the resolving manner of the requested Body parameter.
The following list of response parameters is obtained:
Figure BDA0001121349320000152
Figure BDA0001121349320000161
the following describes the structure and function of the API registry apparatus 1, the test API gateway 2 and the API interface parser 3 in the REST API fast registration system according to the present invention by using specific examples:
FIG. 5 is a diagram illustrating an API registry apparatus according to a first embodiment of the present invention. As shown in fig. 5, the API registry apparatus 1 of the embodiment of fig. 2 may include a basic information receiving module 11, a basic information sending module 12 and a parameter list receiving module 13, wherein:
and a basic information receiving module 11, configured to receive basic information of the representational state transfer REST application programming interface API input by the user.
A basic information sending module 12, configured to send the basic information of the REST API to the test API gateway 2, so that the test API gateway 2 forwards a REST API request packet and a response packet to the API interface parser 3.
And the parameter list receiving module 13 is configured to receive the parameter list and the call example that are parsed from the REST API request packet and the response packet by the API interface parser 3, so as to complete the registration process of the entire REST API.
Based on the API registry apparatus provided in the above embodiment of the present invention, for the problems of low efficiency, error vulnerability, poor flexibility, and the like existing in the current REST API registration management, the REST API registration information is divided into two parts of contents, namely, manually entered API name, URL, and other basic information, and then the parameter list and calling example of the REST API are automatically extracted from the request data packet of the REST API, so as to complete the registration process of the whole REST API, thereby implementing flexible, fast, and consistent REST API registration management.
FIG. 6 is a diagram illustrating an API registry apparatus according to a second embodiment of the present invention. Compared with the embodiment shown in fig. 5, in the embodiment shown in fig. 6, the API registry apparatus 1 may further include at least one of a parameter modification module 14, a registration information publishing module 15 and a registration information presenting module 16, wherein:
and the parameter modification module 14 is configured to delete and modify the parameter list and the call example after receiving a modification instruction of a user.
For example: parameter modification module 14 may delete parameters and instances that do not need to be published as directed by the user.
Therefore, the embodiment of the invention increases the user checking link, thereby improving the accuracy and the difference of the API registration information, improving the user experience, and enabling the user to select the parameters and examples to be issued according to the requirements.
And the registration information issuing module 15 is configured to issue API registration information to the formal API gateway after receiving a confirmation instruction of the user, so that the third party application calls the REST API through the formal API gateway.
Therefore, the embodiment of the invention increases the links of user checking and confirmation, thereby further improving the accuracy of the API registration information.
And the registration information presentation module 16 is configured to send the registration information of the REST API to the API web portal for the developer to view after receiving an API registration information viewing request sent by the developer through the API web portal.
Therefore, the embodiment of the invention facilitates the checking and management of the API registration information by the developer, and improves the use experience of the developer.
FIG. 7 is a diagram of a test API gateway according to a first embodiment of the present invention. As shown in fig. 7, the test API gateway 2 of the embodiment of fig. 2 may include a service port creation module 21, a request receiving module 22 and a request forwarding module 23, where:
the service port creating module 21 is configured to receive basic information of the representational state transfer REST API sent by the API registry apparatus 1, create an API front-end service port according to the basic information, and bind the API back-end server.
And a request receiving module 22, configured to receive a REST API request packet sent by an API provider by using the API testing client.
A request forwarding module 23, configured to forward the REST API request packet to a back-end API server bound to a front-end API port and an API interface parser 3, so that the API interface parser 3 parses a parameter list and a call example from the REST API request packet, and writes the parameter list and the call example into an API registry, where the parameter list includes request parameters, and the call example includes a request example.
Based on the test API gateway provided by the embodiment of the invention, aiming at the problems of low efficiency, error proneness, poor flexibility and the like existing in the current REST API registration management, the request data packet from the REST API is sent to the API interface resolver, so that the API interface resolver can automatically extract the interface information of the REST API, the registration process of the REST API is simplified, and the REST API registration efficiency is improved. The method of the embodiment of the invention combines the registration process of the API with the test process of the API, so that the registration information of the API is consistent with the back end of the API, thereby improving the quality of the registration information of the REST API.
FIG. 8 is a diagram of a second embodiment of a test API gateway in accordance with the present invention. Compared with the embodiment shown in fig. 7, in the embodiment shown in fig. 8, the test API gateway 2 may further include a response receiving module 24 and a response forwarding module 25, where:
and the response receiving module 24 is configured to receive a REST API response packet returned by the back-end API server after processing the REST API request.
And a response forwarding module 25, configured to forward the REST API response packet to the API interface parser 3, so that the API interface parser 3 parses a parameter list and a call example from the REST API request packet, and writes the parameter list and the call example into the API registry, where the parameter list further includes response parameters, and the call example further includes a response example.
The embodiment of the invention automatically extracts the interface information of the REST API from the request and response data packet of the REST API, thereby simplifying the registration process of the REST API and improving the registration efficiency of the REST API.
FIG. 9 is a diagram illustrating an embodiment of an API interface parser in accordance with the present invention. As shown in fig. 9, the 9API interface parser 3 of the embodiment of fig. 2 includes a packet receiving module 31, a packet parsing module 32 and a parameter writing module 33, where:
the data packet receiving module 31 is configured to receive a representational state transfer REST application programming interface API request packet forwarded by the test API gateway 2, where the test API gateway 2 forwards the REST API request packet to a back-end API server bound to a front-end API port and the API interface parser 3 when receiving the REST API request packet sent by an API provider using an API test client.
And the data packet analysis module 32 is configured to analyze a parameter list and a call example from the REST API request packet, where the parameter list includes request parameters, and the call example includes a request example.
And a parameter writing module 33, configured to write the parameter list and the call examples into the API registry.
In an embodiment of the present invention, the data packet receiving module 31 may be further configured to receive a REST API response packet forwarded by the test API gateway 2, where the test API gateway 2 forwards the REST API response packet to the API interface parser 3 when receiving the REST API response packet returned by the back-end API server after processing the REST API request; the data packet parsing module 32 may be further configured to parse a parameter list and a call example from the REST API request packet, where the parameter list further includes a response parameter, and the call example further includes a response example.
Based on the API interface resolver provided by the above embodiment of the present invention, aiming at the problems of low efficiency, error vulnerability, poor flexibility, and the like existing in the current REST API registration management method, the interface information of the REST API is automatically extracted from the request and response data packet of the REST API, so that the registration process of the REST API is simplified, and the REST API registration efficiency is improved. The method of the embodiment of the invention combines the registration process of the API with the test process of the API, so that the registration information of the API is consistent with the back end of the API, thereby improving the quality of the registration information of the REST API.
In an embodiment of the present invention, the data packet parsing module 32 may be specifically configured to parse data in YAML, XML, and JSON data formats in a REST API request packet or a REST API response packet.
The embodiment of the invention can realize the analysis of the data with different data formats such as YAML, XML, JSON and the like.
In an embodiment of the present invention, the data packet parsing module 32 may be specifically configured to perform multiple parameter parsing on multiple REST API requests in a REST API request process and multiple REST API responses in a REST API response process; and summarizing the parameter analysis results for multiple times, and determining a final parameter list of the REST API.
In an embodiment of the present invention, the data packet parsing module 32 may be specifically configured to summarize a URL template and a Path parameter result in multiple parameter parsing results, and determine a final URL template and a Path parameter; summarizing the parameter types of Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters; summarizing the parameters of the HttpStatus Code and the Status Message responded by the API in the multiple parameter analysis results, and determining the final parameter values of the HttpStatus Code and the Status Message.
The embodiment of the invention can carry out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process, and summarize the multiple parameter analysis results to determine the final parameter list of the REST API. Therefore, the embodiment of the invention improves the instruction for analyzing the API parameters, thereby further improving the quality of the REST API registration information.
Fig. 10 is a diagram illustrating a packet parsing module according to an embodiment of the invention. As shown in fig. 10, the packet parsing module 32 of fig. 9 may be subdivided into three modules: API request header parsing module 321, API response header parsing module 322, and Body parsing module 323, wherein:
both API request header parsing module 321 and API reply header parsing module 322 call (or rely on) Body parsing module 323.
The API request Header parsing module 321 may include an http parameter parsing unit, a URL template parsing unit, a Path parameter parsing unit, a Query parameter parsing unit, a Header parameter parsing unit, and a type parsing unit, which are respectively configured to parse http parameter, a URL template, a Path parameter, a Query parameter, a Header parameter, and various parameter types in the API request Header.
The API response Header parsing module 322 may include a StatusCode parsing unit, a Header parameter parsing unit, and a type parsing unit, which are respectively used for parsing a StatusCode parameter, a Header parameter parsing unit, and each parameter type.
The Body parsing module 323 may include an XML parsing unit, a JSON parsing unit, and a YAML parsing unit, which are respectively used for parsing data in XML, JSON, and YAML data formats in the packet Body.
Wherein, the repeating units such as the Header parameter parsing unit, the type parsing unit, etc. in the API request Header parsing module 321 and the API response Header parsing module 322 can be extracted as a common module.
The API registry apparatus 1, test API gateway 2, API interface parser 3 described above may be implemented as a general purpose processor, a Programmable Logic Controller (PLC), a Digital Signal Processor (DSP), an Application Specific Integrated Circuit (ASIC), a Field Programmable Gate Array (FPGA) or other programmable logic device, discrete gate or transistor logic device, discrete hardware components or any suitable combination thereof for performing the functions described herein.
Thus far, the present invention has been described in detail. Some details well known in the art have not been described in order to avoid obscuring the concepts of the present invention. It will be fully apparent to those skilled in the art from the foregoing description how to practice the presently disclosed embodiments.
It will be understood by those skilled in the art that all or part of the steps for implementing the above embodiments may be implemented by hardware, or may be implemented by a program instructing relevant hardware, where the program may be stored in a computer-readable storage medium, and the above-mentioned storage medium may be a read-only memory, a magnetic disk or an optical disk, etc.
The description of the present invention has been presented for purposes of illustration and description, and is not intended to be exhaustive or limited to the invention in the form disclosed. Many modifications and variations will be apparent to practitioners skilled in this art. The embodiment was chosen and described in order to best explain the principles of the invention and the practical application, and to enable others of ordinary skill in the art to understand the invention for various embodiments with various modifications as are suited to the particular use contemplated.

Claims (16)

1. A REST API rapid registration method is characterized by comprising the following steps:
the API registry device receives basic information of a representational state transfer REST application programming interface API input by a user;
the API parser extracts a parameter list and a calling example of the REST API from a request packet and a response packet of the REST API so as to complete the registration process of the whole REST API;
the step of extracting the parameter list of the REST API from the request packet and the response packet of the REST API by the API interface resolver comprises the following steps:
performing multiple times of parameter analysis on multiple REST API requests in the REST API request process and multiple times of REST API responses in the REST API response process;
and summarizing the parameter analysis results for multiple times, and determining a final parameter list of the REST API.
2. The method of claim 1, wherein the API registry apparatus receiving user input of basic information of a representational state transfer REST application programming interface API comprises:
the method comprises the following steps that an API registry device receives basic information of REST API input by a user;
the API registry device sends the basic information of the REST API to the test API gateway;
and the test API gateway creates an API front-end service port according to the basic information and binds an API rear-end server.
3. The method of claim 1, wherein the API interface parser extracting the parameter list and call instances of the REST API from request and response packets of the REST API comprises:
the method comprises the steps that a test API gateway receives an REST API request packet sent by an API provider through an API test client;
the test API gateway forwards the REST API request packet to a back-end API server bound with a front-end API port and an API interface resolver;
the API parser parses out a parameter list and a call instance from the REST API request packet, wherein the parameter list includes request parameters and the call instance includes a request instance.
4. The method of claim 3, wherein extracting the parameter list and call instances of the REST API from the request packet and the response packet of the REST API further comprises:
the back-end API server processes the REST API request and returns a REST API response packet to the test API gateway;
the test API gateway forwards the REST API response packet to an API interface resolver;
the API parser parses out a parameter list and a call instance from the REST API response packet, wherein the parameter list includes response parameters and the call instance includes a response instance.
5. The method of any of claims 1-4, wherein the step of the API interface parser extracting the parameter list of the REST API from the request and response packets of the REST API comprises:
and analyzing the data in YAML, XML and JSON data formats in the REST API request packet and the response packet.
6. The method of any of claims 1-4, wherein aggregating results of multiple parameter resolutions, determining a final REST API parameter list comprises:
summarizing the URL template and the Path parameter result in the multiple parameter analysis results, and determining the final URL template and Path parameter;
summarizing the parameter types of Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters;
summarizing the parameters of the HttpStatus Code and the Status Message responded by the API in the multiple parameter analysis results, and determining the final parameter values of the HttpStatus Code and the Status Message.
7. The method according to any one of claims 1-4, further comprising:
the API parser writes the parameter list and the calling example into an API registry;
and/or the presence of a gas in the gas,
after receiving a modification instruction of a user, the API registry device deletes and modifies the parameter list and the calling example;
and/or the presence of a gas in the gas,
after receiving a confirmation instruction of a user, the API registry device issues API registration information to a formal API gateway so that a third party application can call an REST API through the formal API gateway;
and/or the presence of a gas in the gas,
and after receiving an API registration information viewing request sent by a developer through the API portal website, the API registry device sends the registration information of the REST API to the API portal website so as to facilitate the developer to view.
8. An API registry apparatus comprising a basic information receiving module, a basic information transmitting module, and a parameter list receiving module, wherein:
the basic information receiving module is used for receiving basic information of a representational state transfer REST application programming interface API input by a user;
the basic information sending module is used for sending the basic information of the REST API to the test API gateway so that a REST API request packet and a response packet of the test API gateway can be forwarded to the API interface resolver;
and the parameter list receiving module is used for receiving a parameter list and a calling example which are analyzed by the API (application programming interface) analyzer from the REST API request packet and the response packet so as to complete the registration process of the whole REST API, wherein the API analyzer carries out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process, summarizes the multiple parameter analysis results and determines the final parameter list of the REST API.
9. The API registry apparatus of claim 8 further comprising at least one of a parameter modification module, a registration information publishing module and a registration information presenting module, wherein:
the parameter modification module is used for deleting and modifying the parameter list and the calling example after receiving a modification instruction of a user;
the registration information issuing module is used for issuing API registration information to the formal API gateway after receiving a confirmation instruction of a user so that a third party application can call the REST API through the formal API gateway;
and the registration information presentation module is used for sending the registration information of the REST API to the API portal website after receiving an API registration information viewing request sent by a developer through the API portal website so as to facilitate the developer to view.
10. A test API gateway, comprising a service port creation module, a request receiving module, and a request forwarding module, wherein:
the service port creating module is used for receiving basic information of the representational state transfer (REST) API sent by the API registry device, creating an API front-end service port according to the basic information and binding an API rear-end server;
the request receiving module is used for receiving a REST API request packet sent by an API provider by utilizing an API test client;
and the request forwarding module is used for forwarding the REST API request packet to a back-end API server bound with a front-end API port and an API interface resolver so that the API interface resolver can analyze a parameter list and a calling example from the REST API request packet and write the parameter list and the calling example into an API registry, wherein the parameter list comprises request parameters, the calling example comprises a request example, the API interface resolver carries out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process, summarizes multiple parameter analysis results and determines a final parameter list of the REST API.
11. The test API gateway of claim 10 further comprising an answer receiving module and an answer forwarding module, wherein:
the response receiving module is used for receiving a REST API response packet returned after the REST API request is processed by the back-end API server;
and the response forwarding module is used for forwarding the REST API response packet to the API interface parser so that the API interface parser parses a parameter list and a calling example from the REST API request packet and writes the parameter list and the calling example into the API registry, wherein the parameter list further comprises response parameters, and the calling example further comprises a response example.
12. An API (application programming interface) parser is characterized by comprising a data packet receiving module, a data packet parsing module and a parameter writing module, wherein:
the system comprises a data packet receiving module, a testing API gateway and a state transfer REST Application Programming Interface (API) parser, wherein the data packet receiving module is used for receiving an API request packet of a representational state transfer (REST) application programming interface forwarded by the testing API gateway, and the testing API gateway forwards the REST API request packet to a back-end API server bound with a front-end API port and the API parser when receiving the REST API request packet sent by an API provider by utilizing an API testing client;
the data packet analysis module is used for analyzing a parameter list and a calling example from a REST API request packet, wherein the parameter list comprises request parameters, and the calling example comprises the request example;
the parameter writing module is used for writing the parameter list and the calling example into an API registry;
the data packet analysis module is used for carrying out multiple parameter analysis on multiple REST API requests in the REST API request process and multiple REST API responses in the REST API response process; and summarizing the parameter analysis results for multiple times, and determining a final parameter list of the REST API.
13. An API interface parser in accordance with claim 12,
the data packet receiving module is also used for testing an REST API response packet forwarded by the API gateway, wherein the testing API gateway forwards the REST API response packet to the API interface resolver when receiving the REST API response packet returned after the REST API request is processed by the back-end API server;
the data packet analysis module is further configured to analyze a parameter list and a call example from the REST API request packet, where the parameter list further includes a response parameter, and the call example further includes a response example.
14. An API interface parser according to claim 12 or 13,
and the data packet analysis module is used for analyzing the data in YAML, XML and JSON data formats in the REST API request packet or the REST API response packet.
15. An API interface parser according to claim 12 or 13,
the data packet analysis module is used for summarizing the URL template and the Path parameter result in the multiple parameter analysis results and determining the final URL template and Path parameter; summarizing the parameter types of Path, Query, Header and Body parameters in the multiple parameter analysis results, and determining the final parameter types of the Path, Query, Header and Body parameters; summarizing the parameters of the HttpStatus Code and the Status Message responded by the API in the multiple parameter analysis results, and determining the final parameter values of the HttpStatus Code and the Status Message.
16. A REST API fast registration system comprising an API registry apparatus according to claim 8 or 9, a test API gateway according to claim 10 or 11, and an API interface parser according to any of claims 12-15.
CN201610855017.4A 2016-09-27 2016-09-27 REST API rapid registration method, device and system Active CN107872484B (en)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN201610855017.4A CN107872484B (en) 2016-09-27 2016-09-27 REST API rapid registration method, device and system

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN201610855017.4A CN107872484B (en) 2016-09-27 2016-09-27 REST API rapid registration method, device and system

Publications (2)

Publication Number Publication Date
CN107872484A CN107872484A (en) 2018-04-03
CN107872484B true CN107872484B (en) 2020-12-25

Family

ID=61751267

Family Applications (1)

Application Number Title Priority Date Filing Date
CN201610855017.4A Active CN107872484B (en) 2016-09-27 2016-09-27 REST API rapid registration method, device and system

Country Status (1)

Country Link
CN (1) CN107872484B (en)

Cited By (1)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
WO2022145503A1 (en) * 2020-12-30 2022-07-07 한국전자기술연구원 Method for providing semantic rest api

Families Citing this family (12)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN109144512B (en) * 2018-08-22 2022-05-03 杭州数澜科技有限公司 Method and system for generating API
CN109151091B (en) * 2018-09-21 2022-01-21 福建南威软件有限公司 API gateway service supporting dubbo protocol calling
CN110968744B (en) 2018-09-30 2023-09-05 中国移动通信有限公司研究院 Resource query method and device, equipment and storage medium
CN109558311A (en) * 2018-10-26 2019-04-02 深圳点猫科技有限公司 A kind of the automation interface method of calibration and electronic equipment of educational system
CN111506365A (en) * 2019-01-31 2020-08-07 北京数聚鑫云信息技术有限公司 Method and device for automatically constructing API
CN110610069A (en) * 2019-09-09 2019-12-24 苏州浪潮智能科技有限公司 Method and device for calling REST interface in web system
CN110968296B (en) * 2019-12-03 2023-07-25 政采云有限公司 Data acquisition method, device, equipment and readable storage medium
CN111010438B (en) * 2019-12-13 2022-11-11 北京达佳互联信息技术有限公司 Remote procedure calling method, device, server and storage medium
CN112131022B (en) * 2020-09-22 2024-05-14 深圳力维智联技术有限公司 Open API management method, device, system and computer readable storage medium
CN114338783A (en) * 2021-11-08 2022-04-12 浙江高信技术股份有限公司 API management platform based on technical middlebox and management method thereof
CN114257531B (en) * 2021-12-10 2024-02-23 北京金山云网络技术有限公司 Test method and related device for application programming interface API gateway
CN116401650B (en) * 2023-04-14 2023-11-14 苏州慧睿康智能科技有限公司 Determinant-based API finite state security calling method

Citations (5)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN101615116A (en) * 2008-06-23 2009-12-30 成都市华为赛门铁克科技有限公司 A kind of interface acquisition methods, Apparatus and system
CN103561113A (en) * 2013-11-18 2014-02-05 金蝶软件（中国）有限公司 Web Service interface generating method and device
US8676979B2 (en) * 2010-05-18 2014-03-18 Salesforce.Com, Inc. Methods and systems for efficient API integrated login in a multi-tenant database environment
CN104158856A (en) * 2014-07-23 2014-11-19 武汉理工大学 Local API calling method dispense with preset of secure session
CN104639603A (en) * 2014-11-27 2015-05-20 四川长虹电器股份有限公司 RESTful (representational state transfer) service design method based on Spring MVC

Family Cites Families (1)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US9294543B2 (en) * 2014-04-09 2016-03-22 International Business Machines Corporation Generation of representational state transfer interface from application programming interfaces

Patent Citations (5)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN101615116A (en) * 2008-06-23 2009-12-30 成都市华为赛门铁克科技有限公司 A kind of interface acquisition methods, Apparatus and system
US8676979B2 (en) * 2010-05-18 2014-03-18 Salesforce.Com, Inc. Methods and systems for efficient API integrated login in a multi-tenant database environment
CN103561113A (en) * 2013-11-18 2014-02-05 金蝶软件（中国）有限公司 Web Service interface generating method and device
CN104158856A (en) * 2014-07-23 2014-11-19 武汉理工大学 Local API calling method dispense with preset of secure session
CN104639603A (en) * 2014-11-27 2015-05-20 四川长虹电器股份有限公司 RESTful (representational state transfer) service design method based on Spring MVC

Cited By (1)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
WO2022145503A1 (en) * 2020-12-30 2022-07-07 한국전자기술연구원 Method for providing semantic rest api

Also Published As

Publication number Publication date
CN107872484A (en) 2018-04-03

Similar Documents

Publication Publication Date Title
CN107872484B (en) REST API rapid registration method, device and system
US9811402B2 (en) Generation of representational state transfer interface from application programming interfaces
CN105099811B (en) Interface testing method and device
US8543869B2 (en) Method and system for reconstructing error response messages under web application environment
US20150317156A1 (en) Systems and Methods for Automated Generation of Interactive Documentation Based on Web Application Description Language Files
US8799714B1 (en) Generating test scenarios from application-layer messages
CN109902247B (en) Page rendering method and device and electronic equipment
US10452730B2 (en) Methods for analyzing web sites using web services and devices thereof
CN111859236B (en) Server rendering page generation method and system based on dynamic form verification
US20220035661A1 (en) Task generation
CN112882844B (en) Joint debugging method, device and storage medium based on network front end and network back end
WO2021093673A1 (en) E-mail sending method, apparatus and device, and computer-readable storage medium
CN103902539B (en) Extensible markup analysis method and device
Bojinov RESTful Web API Design with Node. js 10: Learn to create robust RESTful web services with Node. js, MongoDB, and Express. js
CN111767229A (en) Performance test method, device and equipment
Balachandar RESTful Java Web Services: A pragmatic guide to designing and building RESTful APIs using Java
CN102799629B (en) WSDL (Web Services Description Language) file quality ensuring system and realizing method thereof
CN112379965B (en) Sandbox file mapping system, client device, mapping end device, sandbox file mapping method and electronic equipment
CN117632710A (en) Method, device, equipment and storage medium for generating test code
CN104253835B (en) User behavior data acquisition method and its system
CN107239265B (en) Binding method and device of Java function and C function
CN115396501B (en) Information processing method and device, electronic equipment and readable storage medium
Bojinov RESTful Web API Design with Node. js
KR20090028366A (en) System and method for testing program source code and program recording medium
CN112597036A (en) Universal baffle testing method and device

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination
GR01 Patent grant
GR01 Patent grant