CN116028018A - API data service development management method based on data set - Google Patents
API data service development management method based on data set Download PDFInfo
- Publication number
- CN116028018A CN116028018A CN202111249723.1A CN202111249723A CN116028018A CN 116028018 A CN116028018 A CN 116028018A CN 202111249723 A CN202111249723 A CN 202111249723A CN 116028018 A CN116028018 A CN 116028018A
- Authority
- CN
- China
- Prior art keywords
- data set
- api
- data service
- data
- management method
- 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.)
- Pending
Links
Images
Abstract
The invention discloses an API data service development management method based on a data set, which comprises the following steps: creating an API through the data set; defining request and return parameters based on the dataset information; a new application is created in the application management interface. The invention solves the defects that in the development of the current software application, the handwriting data service code is complex and the developed API interface cannot be visually managed.
Description
Technical Field
The invention belongs to the technical field of API data service development and management, and particularly relates to an API data service development and management method based on a data set.
Background
In software system development, development of a data query interface is often involved. Conventional interface development involves configuring data sources, defining interface parameters and interface request paths, writing query SQL (Structured Query Language ) and code logic, among other operations. Not only is the development period long, multiple data sources cannot be flexibly supported, but also the code logic cannot be subjected to hot modification. Part of the API (Application Programming Interface, application program interface) management system supports the interface definition and documentation of the management API interface, taking Swagger (a canonical and complete framework) interface document management system as an example, which can only view interface documents and call testing of interfaces, but does not support the implementation of online development of interfaces. In this case:
1. the developer needs to modify the business logic of the interface, e.g., the interface updates from returning only daily order quantity to returning daily order amount and order quantity. The corresponding query code needs to be modified to arrange for functional online. Development costs and subsequent maintenance costs are increased.
2. If a new data source is added to the service system, a developer needs to add a new data source driver, and new interface query logic is developed on the basis of the new data source driver. On-line thermal modification of the interface logic is not achieved.
Therefore, swagger manages interface information, needs to manually configure access fields in the code, and if the interface document needs to be modified, needs to modify the code and perform online operation, and cannot modify the interface document online. Swagger does not have the ability to develop interfaces, and cannot manually generate interfaces by way of configuration datasets, etc. Swagger can only manage the interface of the access code itself, can not manage the interfaces of other systems, and can not perform operations such as interface test on the interfaces of other systems.
Disclosure of Invention
The technical problem to be solved by the invention is to overcome the defects in the prior art and provide an API data service development and management method based on a data set.
The invention solves the technical problems by the following technical scheme:
the invention provides an API data service development management method based on a data set, which comprises the following steps:
creating an API through the data set;
defining request and return parameters based on the dataset information;
a new application is created in the application management interface.
Preferably, the data set supports several types of data sources.
Preferably, several types of data sources include MySQL, clickhouse, elasticsearch, hive, kylin, mongo, oracle, presto, phoenix, SQL Server, vertical.
Preferably, the method further comprises the steps of:
a data set is entered.
Preferably, entering the data set comprises:
manual configuration, handwriting SQL, and interface specification 3 modes.
Preferably, the method further comprises:
the request mode, the request parameter, the return parameter and the request path of the online management interface.
Preferably, the method further comprises:
and performing authority control on the API based on the application generation token.
Preferably, the method further comprises:
the data set is configured.
Preferably, the method further comprises:
the application is given the creation of Token by adding and configuring a new application.
Preferably, the method further comprises:
APIs are partitioned into specific packets at the time they are created or registered.
The invention has the positive progress effects that: the invention solves the defects that in the development of the current software application, the handwriting data service code is complex and the developed API interface cannot be visually managed.
Drawings
Fig. 1 is a flowchart of a data set-based API data service development management method according to embodiment 1 of the present invention.
Fig. 2 is a schematic structural diagram of an electronic device according to embodiment 2 of the present invention.
Detailed Description
The invention is further illustrated by means of the following examples, which are not intended to limit the scope of the invention.
Example 1
The embodiment provides an API data service development management method based on a data set. Referring to fig. 1, the data set-based API data service development management method includes the steps of:
step S101, creating an API through the data set.
Step S102, request and return parameters are defined based on the data set information.
Step S103, a new application is created in the application management interface.
In a first alternative embodiment, an API is created based on the data set.
In a second alternative embodiment, registration is based on an existing API.
In a third alternative embodiment, an option is provided through the user interface for the user to select "generate API mode", which the user can select "data set configuration", i.e. create an API through the data set, or "add existing API", i.e. register based on existing APIs.
Then, basic information of the API is defined. Basic information of the API includes: name, grouping, way of generating the API (data set configuration & adding existing API), path and request way of the API (Get, post), whether authorization is needed, if no grouping information can directly create a grouping, the API is created through the data set.
As an alternative embodiment, the data set supports several types of data sources.
As a preferred embodiment, several types of data sources include MySQL, clickhouse, elasticsearch, hive, kylin, mongo, oracle, presto, phoenix. SQL (structured query language)Server、vertica。
In an alternative embodiment, the method further comprises the steps of:
a data set is entered.
In particular implementations, entering the data set includes: manual configuration, handwriting SQL, and interface specification 3 modes.
In some alternative embodiments, the method further comprises:
the request mode, the request parameter, the return parameter and the request path of the online management interface.
In some alternative embodiments, the method further comprises:
and performing authority control on the API based on the application generation token.
In some alternative embodiments, the method further comprises:
the data set is configured.
In some alternative embodiments, the method further comprises:
the application is given the creation of Token by adding and configuring a new application.
In some alternative embodiments, the method further comprises:
APIs are partitioned into specific packets at the time they are created or registered.
The method for developing and managing the API data service based on the data sets of the embodiment provides an API interface which can be used for calling an application program based on the SQL data sets created in a visualized mode. Meanwhile, management and authentication services are provided for the generated API interface, and life cycle stages such as design, test, online, authorization, offline and the like of the API are covered. The embodiment solves the defects that in the development of the current software application, the handwriting data service codes are complex and the developed API interface cannot be visually managed.
The data set-based API data service development management method of the present embodiment is based on an API data service system having the following functions:
support configuration of SQL data sets based on more than 10 data sources;
an API interface may be generated based on an existing dataset;
the existing API interface can be managed in the system;
the path, grouping, request mode, request parameter and return parameter configuration of the user-defined API interface;
API interface test function;
a management function of the up-down line of the API interface;
providing application management of an API calling party, and performing API authorization control on an application;
authentication management of the API;
a declarative view of the API document may be provided.
The API data service development management method based on the data set can generate the data service API for calling by configuring the data set, flexibly configure the access parameters of the interface on the page, and save the code development process.
The method for developing and managing the API data service based on the data set can manage the existing interface in the system and provide functions of checking the entry of the interface, authorizing the application, manually testing and the like.
The method for developing and managing the API data service based on the data set can perform configuration management on interfaces without modifying code visualization, such as modifying SQL logic, access parameters, application authorization and the like of the data set corresponding to the interfaces, and modified contents can be validated in real time.
In practice, the data service may define the API in two ways, the first: defining the entry and exit of the data service API based on the data set configuration mode, and then setting the call Token and the authorization information release of the API to be called; the second is to register the existing API service, and the existing API performs unified configuration and authentication management in the data service through the registration procedure.
Request parameters of the data service API are configured based on the data set.
The whole data service management is used for managing the operations of online, authorization, editing, testing, deleting and the like of the data service API.
In order to facilitate better management and invocation of the data service APIs, there is management and configuration of applications in the data service module, giving applications the generation of Token by adding and configuring new applications.
The authentication mechanism of the API in the data service is a very important link, and in the whole, the authority management of the security call is provided by the data service, a Token can be generated for each application in the data service development management system, and only one Token is effective for one application. Other Token may be immediately deactivated if the Token is regenerated, or may be manually deactivated.
API services, with increasing numbers, create a grouping concept in the overall data service module to facilitate management and use, and divide APIs into a particular grouping when creating or registering APIs to facilitate later maintenance, management and distribution.
When a new API is configured or registered, the availability of the API and the content of the returned result can be tested through a test function, and the token information can be moved through detailed information in service management after the configuration of the whole data service API is completed in test to check the basic information, calling information, request parameters and return parameters of the whole API.
Creating an API based on the data set or registering based on the existing API;
basic information defining an API, including: name, grouping, manner of generating API (data set configuration & adding existing API), path of API and request manner (Get, post), whether authorization is needed;
the request parameters and the return parameters of the configuration API specifically comprise the definition of types, whether filling is needed and default values;
setting return result examples, supporting that a data service API has completed basic setting;
creating applications requiring the use of APIs in application management, wherein each application correspondingly generates a code;
selecting an application needing to use the data service in the API authentication, defining an application name and the validity period of the Token to generate the Token;
the API is authorized to the appointed application, and the call to the API can be completed by using the generated Token.
This example, in combination with the actual situation, implements a specific data service instance according to the following implementation:
based on newly establishing the API by the data set or registering by the existing API, defining basic information of the API, including: name, grouping, way of generating the API (data set configuration & adding existing API), path and request way of the API (Get, post), whether authorization is needed, if no grouping information can directly create a grouping, the API is created through the data set.
Request and return parameters (type, padding, default settings) are defined based on the dataset information.
Thus far, the API configuration based on the data set is completed, and a new application is created in the application management interface.
After the application is established, selecting the application to set the Token validity period in the API authentication management, and generating a new Token;
after Token is created, the created API is specified to be online on a service management page and is authorized to a specified application, and the application can use Token information to call;
parameters may be used at the service management page to make test calls to the APIs.
Example 3
Fig. 2 is a schematic structural diagram of an electronic device according to the present embodiment. The electronic device includes a memory, a processor, and a computer program stored on the memory and executable on the processor, which when executed implements the data set-based API data service development management method of embodiment 1. The electronic device 30 shown in fig. 2 is merely an example and should not be construed as limiting the functionality and scope of use of embodiments of the present invention.
As shown in fig. 2, the electronic device 30 may be embodied in the form of a general purpose computing device, which may be a server device, for example. Components of electronic device 30 may include, but are not limited to: the at least one processor 31, the at least one memory 32, a bus 33 connecting the different system components, including the memory 32 and the processor 31.
The bus 33 includes a data bus, an address bus, and a control bus.
The processor 31 executes various functional applications and data processing, such as the API data service development management method based on the data set of embodiment 1 of the present invention, by running a computer program stored in the memory 32.
The electronic device 30 may also communicate with one or more external devices 34 (e.g., keyboard, pointing device, etc.). Such communication may be through an input/output (I/O) interface 35. Also, model-generating device 30 may also communicate with one or more networks, such as a Local Area Network (LAN), a Wide Area Network (WAN), and/or a public network, such as the internet, via network adapter 36. As shown, network adapter 36 communicates with the other modules of model-generating device 30 via bus 33. It should be appreciated that although not shown in the figures, other hardware and/or software modules may be used in connection with the model-generating device 30, including, but not limited to: microcode, device drivers, redundant processors, external disk drive arrays, RAID (disk array) systems, tape drives, data backup storage systems, and the like.
It should be noted that although several units/modules or sub-units/modules of an electronic device are mentioned in the above detailed description, such a division is merely exemplary and not mandatory. Indeed, the features and functionality of two or more units/modules described above may be embodied in one unit/module in accordance with embodiments of the present invention. Conversely, the features and functions of one unit/module described above may be further divided into ones that are embodied by a plurality of units/modules.
Example 3
The present embodiment provides a computer-readable storage medium having stored thereon a computer program which, when executed by a processor, implements the steps of the data set-based API data service development management method of embodiment 1.
More specifically, among others, readable storage media may be employed including, but not limited to: portable disk, hard disk, random access memory, read only memory, erasable programmable read only memory, optical storage device, magnetic storage device, or any suitable combination of the foregoing.
In a possible embodiment, the invention may also be implemented in the form of a program product comprising program code for causing a terminal device to carry out the steps of implementing the data set based API data service development management method of embodiment 1 when said program product is run on said terminal device.
Wherein the program code for carrying out the invention may be written in any combination of one or more programming languages, which program code may execute entirely on the user device, partly on the user device, as a stand-alone software package, partly on the user device and partly on the remote device or entirely on the remote device.
While specific embodiments of the invention have been described above, it will be appreciated by those skilled in the art that this is by way of example only, and the scope of the invention is defined by the appended claims. Various changes and modifications to these embodiments may be made by those skilled in the art without departing from the principles and spirit of the invention, but such changes and modifications fall within the scope of the invention.
Claims (10)
1. The API data service development management method based on the data set is characterized by comprising the following steps:
creating an API through the data set;
defining request and return parameters based on the dataset information;
a new application is created in the application management interface.
2. The method for managing development of a data set-based API data service of claim 1, wherein said data set supports several types of data sources.
3. The method of claim 2, wherein the plurality of types of data sources include MySQL, clickhouse, elasticsearch, hive, kylin, mongo, oracle, presto, phoenix, SQL Server, and vertical.
4. The data set-based API data service development management method as recited in claim 2, further comprising the steps of:
a data set is entered.
5. The method for data set-based API data service development management of claim 4, wherein said entering a data set comprises:
manual configuration, handwriting SQL, and interface specification 3 modes.
6. The data set-based API data service development management method of claim 4, further comprising:
the request mode, the request parameter, the return parameter and the request path of the online management interface.
7. The data set-based API data service development management method of claim 4, further comprising:
and performing authority control on the API based on the application generation token.
8. The data set-based API data service development management method as recited in claim 1, wherein said data set-based API data service development management method further comprises:
the data set is configured.
9. The data set-based API data service development management method as recited in claim 1, wherein said data set-based API data service development management method further comprises:
the application is given the creation of Token by adding and configuring a new application.
10. The data set-based API data service development management method as recited in claim 1, wherein said data set-based API data service development management method further comprises:
APIs are partitioned into specific packets at the time they are created or registered.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202111249723.1A CN116028018A (en) | 2021-10-26 | 2021-10-26 | API data service development management method based on data set |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202111249723.1A CN116028018A (en) | 2021-10-26 | 2021-10-26 | API data service development management method based on data set |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN116028018A true CN116028018A (en) | 2023-04-28 |
Family
ID=86069277
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202111249723.1A Pending CN116028018A (en) | 2021-10-26 | 2021-10-26 | API data service development management method based on data set |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN116028018A (en) |
-
2021
- 2021-10-26 CN CN202111249723.1A patent/CN116028018A/en active Pending
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN107370786B (en) | General information management system based on micro-service architecture | |
| US9576257B2 (en) | Integrating data-handling policies into a workflow model | |
| US20190243665A1 (en) | Application runtime configuration using design time artifacts | |
| CN112748908A (en) | Restful service development method and device based on SSM framework | |
| Oliveira et al. | BPMN patterns for ETL conceptual modelling and validation | |
| Ranabahu et al. | Application portability in cloud computing: an abstraction-driven perspective | |
| CN108647300A (en) | Database access intermediate system, method, equipment and storage medium | |
| US8463755B2 (en) | System and method for providing collaborative master data processes | |
| US9063995B2 (en) | Access control list (ACL) generation for replicated data | |
| CN106600226A (en) | Method and device used for optimizing flow management system | |
| US20240143909A1 (en) | System and Method for Electronic Document Interaction with External Resources | |
| AU2017276243B2 (en) | System And Method For Generating Service Operation Implementation | |
| US9946885B2 (en) | Process-oriented modeling and flow to restrict access to objects | |
| Annett | Working with Legacy Systems: A practical guide to looking after and maintaining the systems we inherit | |
| CN116028018A (en) | API data service development management method based on data set | |
| Paz | Microsoft Azure Cosmos DB Revealed: A Multi-Model Database Designed for the Cloud | |
| WO2020155167A1 (en) | Application of cross-organizational transactions to blockchain | |
| CN115879895B (en) | Protocol admittance method, device, computer equipment and storage medium | |
| US11321093B1 (en) | Multilayered generation and processing of computer instructions | |
| CN109684386B (en) | Report collaborative arrangement method and device | |
| RU2783782C1 (en) | System and method for managing notifications | |
| CN115543969B (en) | Data migration method, device, equipment and medium | |
| US11836496B2 (en) | Multilayered generation and processing of computer instructions | |
| US20230123965A1 (en) | Management of metadata groups and associated workflows | |
| US11704093B2 (en) | Rapid prototyping of user experience components and related application functionality |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication |