API verification and API document generation method and system based on API gateway

A document generation and gateway technology, applied in the direction of program files, program code conversion, software deployment, etc., to achieve the effects of ensuring standardization, reducing workload, good practice and consistency

Pending Publication Date: 2022-04-29
上海沄熹科技有限公司
View PDF0 Cites 0 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

[0008] The technical task of the present invention is to provide an API gateway-based API verification and API document generation method and system to solve the problem of how to perform API identification verification and API document writing, and reduce the learning burden of developers

Method used

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
View more

Image

Smart Image Click on the blue labels to locate them in the text.
Viewing Examples
Smart Image
  • API verification and API document generation method and system based on API gateway

Examples

Experimental program
Comparison scheme
Effect test

Embodiment 1

[0042] as attached figure 1 As shown, the API gateway-based API verification and API document generation method of the present invention, the method is to perform API normative verification on the access gateway API based on the open API standard when the upstream service is connected to the gateway; and provide a docking The representation state transfer application programming interface (Restful API) of the ingress gateway automatically generates API resource documents based on the swagger specification; for each upstream service of the access gateway, the input API is automatically analyzed through the verification tool of the Restful API, and then Use relevant methods to find whether it meets the standards; after checking, the relevant information will be entered into the user API; the method is as follows:

[0043] S101. Enter the external interface that needs to be exposed through the API gateway into the gateway, and realize the forwarding of traffic from the externally e...

Embodiment 2

[0052] The API verification and API document generation system based on the API gateway of the present invention, the system includes,

[0053] The entry module is used for the user to operate the API gateway to enter the API, and for each entered API, identify its host, path, parameters, request model and response model;

[0054] The verification module is used to define the validity of the characters in the API according to the resource type definition metafile, verify the legitimacy of the API through the verification tool of RestfulAPI, and generate a verified response to feedback to the user;

[0055] The operation module is used to apply the hypertext markup language operation corresponding to the metadata to the legal API, the swagger template processor in the verification tool based on the available Restful API;

[0056] The conversion module is used to convert the entered API into a mode that conforms to the Swagger specification, traverse each available identifier, a...

Embodiment 3

[0061] The embodiment of the present invention also provides an electronic device, including: a memory and a processor;

[0062] Wherein, the memory stores computer-executable instructions;

[0063] The processor executes the computer-executed instructions stored in the memory, so that the processor executes the API gateway-based API verification and API document generation method in any embodiment of the present invention.

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

PUM

No PUM Login to view more

Abstract

The invention discloses an API (Application Program Interface) verification and API document generation method and system based on an API gateway, belongs to the technical field of computer network API gateways, and aims to solve the technical problem of how to verify an API identifier and write an API document and relieve the learning burden of developers. Performing API normative verification on the access gateway API based on the standard of opening the API; an API (Application Program Interface) resource document based on a swagger specification is automatically generated for an expression state transition application programming interface of the access gateway; for the upstream service of each access gateway, automatically analyzing the entered API through a verification tool of the Restful API, and then using a related method to search whether the standard is met or not; and after checking, inputting related information into the user API.

Description

technical field [0001] The invention relates to the technical field of computer network API gateways, in particular to an API gateway-based API verification and API document generation method and system. Background technique [0002] A gateway is a server, a basic component in the microservice architecture, and a unified entrance to the entire system. It encapsulates the internal architecture of the system and provides a customized API for each client. It may also have other responsibilities such as authentication, monitoring, load balancing, caching, request fragmentation and management, static response handling. [0003] Restful API is based on Representational State Transfer (REST) ​​technology. An architectural style and application used in web services development. REST is popular because of its simplicity, and the fact that it builds on existing systems and the nature of HTTP to achieve its goals. REST is built on top of web technologies, allowing systems built wit...

Claims

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

Application Information

Patent Timeline
no application Login to view more
Patent Type & Authority Applications(China)
IPC IPC(8): G06F8/73G06F8/41G06F8/60
CPCG06F8/73G06F8/447G06F8/60
Inventor 郑志伟袁绍帅
Owner 上海沄熹科技有限公司
Who we serve
  • R&D Engineer
  • R&D Manager
  • IP Professional
Why Eureka
  • Industry Leading Data Capabilities
  • Powerful AI technology
  • Patent DNA Extraction
Social media
Try Eureka
PatSnap group products

Browse by: Latest US Patents, China's latest patents, Technical Efficacy Thesaurus, Application Domain, Technology Topic.

© 2024 PatSnap. All rights reserved.Legal|Privacy policy|Modern Slavery Act Transparency Statement|Sitemap