WO2017041657A1

WO2017041657A1 - Application interface management method and device

Info

Publication number: WO2017041657A1
Application number: PCT/CN2016/097505
Authority: WO
Inventors: 陈晓丹
Original assignee: 阿里巴巴集团控股有限公司
Priority date: 2015-09-09
Filing date: 2016-08-31
Publication date: 2017-03-16
Also published as: CN106528185A

Abstract

Disclosed is an application interface management method and device. Said method comprises: intercepting calling request for an application interface (S101); acquiring annotation information of the application interface (S102); and managing the calling of the application interface in accordance with the annotation information and the calling request (S103). Compared with the prior art, the present application interface management method and device provide, by means of adding annotation information to the existing codes, the information required for the calling process management, thus requiring no change to the existing codes on a large scale or to the main logic of the codes. Code management by means of independently added application interfaces and processing according to annotation information enable calling management for each application interface, thereby reducing the cost resulting from code maintenance.

Description

Application interface management method and device

The present application claims priority to Chinese Patent Application Serial No. No. No. No. No. No. No. No. No. No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

Technical field

The present application relates to the field of computers, and in particular, to an application interface management method and apparatus.

Background technique

In addition to the requirements of completing the service, the existing information system generally needs to set up an open interface to provide external services through the API (Application Programming Interface), and the corresponding service process is accompanied by corresponding The return of indicator data; where the indicator generally refers to the type of data returned by the interface call. For the security of the data, it is generally necessary to check the identity of the caller, and at the same time, it is necessary to control the granularity of the returned indicator according to the identity of the caller.

In the prior art, when the caller authentication and the indicator filtering are performed, the corresponding logic is generally added to the specific implementation code of the interface to perform hard coding. This kind of practice can achieve better maintenance in the early stage of the project, but in the later stage, due to too many interfaces, when the existing code logic is modified, the existing service cannot be guaranteed. At the same time, for code that has not been interface management before, if you need to add this function, it involves the modification of large-scale code.

Summary of the invention

An object of the present application is to provide an application interface management method and apparatus to solve the problem of implementing application interface call management when the existing code is not changed on a large scale or the code body logic is not changed.

According to an aspect of the present application, an application interface management method is provided, wherein the method includes:

Intercepting a call request to an application interface;

Obtaining annotation information of the application interface;

The call of the application interface is managed according to the annotation information and the call request.

According to another aspect of the present application, an application interface management apparatus is provided, wherein the apparatus includes:

An interception module for intercepting a call request to an application interface;

An obtaining module, configured to obtain annotation information of the application interface;

Calling a management module, configured to perform, according to the annotation information and the call request, the call of the application interface management.

Compared with the prior art, the application interface management method and apparatus provided by the present application does not affect the execution logic of the existing code of the application interface because the increase of the annotation information does not need to change the existing code or the code body on a large scale. The logic changes, only need to add annotation information to the existing application interface, and correspondingly introduce additional processing logic, you can manage the interface of different granularity for each interface that is open, thus reducing the value overhead caused by code maintenance. .

DRAWINGS

Other features, objects, and advantages of the present application will become more apparent from the detailed description of the accompanying drawings.

1 is a flow chart showing an application interface management method according to an aspect of the present application;

2 is a schematic flow chart of an application interface management method according to still another aspect of the present application;

FIG. 3 is a schematic structural diagram of an application interface management apparatus according to an aspect of the present application;

FIG. 4 shows a schematic structural diagram of an application interface management apparatus according to still another aspect of the present application.

The same or similar reference numerals in the drawings denote the same or similar components.

detailed description

The present application is further described in detail below with reference to the accompanying drawings.

FIG. 1 is a flow chart showing an application interface management method according to an aspect of the present application. As shown in FIG. 1, the application interface management method includes:

Step S101, intercepting a call request to an application interface;

Step S102: Obtain annotation information of the application interface.

Step S103, managing the call of the application interface according to the annotation information and the call request.

The application interface refers to an API interface. The API interface is pre-added with annotation information, such as Annotation annotation information provided by the Java language, and the annotation information includes management information for calling the API interface, such as management information for calling authentication and index filtering. When receiving the call request to the API interface, intercepting the call request and obtaining the annotation information of the API interface, and then performing call authentication management according to the call authentication information in the annotation information, the caller of the API interface, that is, the service consumer To perform identity control, or to filter and control the information according to the indicators in the annotation information, and to control the granularity of the indicators returned by the API interface. The annotation information can be processed by AOP (Aspect Oriented Programming) technology to control the call of the API interface. The increase in annotation information will not It affects the execution logic of the existing code of the application interface. Therefore, when managing the application interface call, there is no need to change the existing code or change the logic of the code main body on a large scale, and only need to manage the code through the independently added application interface. According to the annotation information, the call management of each application interface can be realized, thereby reducing the value overhead caused by code maintenance, for example, avoiding the service failure caused by the modification of the main logic.

Optionally, the annotation information includes calling authentication information;

The managing the call of the application interface according to the annotation information and the calling request further includes:

Performing call authentication on the call request according to the call authentication information;

After the call authentication is passed, performing a call to the application interface;

When the call authentication fails, an error message is returned.

Here, the call authentication is divided into two kinds of results, the call authentication is passed, and the call to the API interface is executed at this time; the call authentication is not passed, for example, the identity of the caller does not comply with the call permission of the API interface, and according to the return value Type, wrap the error message and return directly.

Optionally, managing the call of the application interface according to the annotation information and the calling request further includes:

Before calling the authentication, it is determined whether the call authentication needs to be performed;

When the call authentication is not required, the call to the application interface is directly executed.

Here, if it is not necessary to perform call authentication for the call of the API interface, the caller of the API interface does not perform call authentication and directly executes the API interface call.

Optionally, the annotation information further includes indicator filtering information;

Performing index filtering on the returned result after the execution of the application interface is performed according to the indicator filtering information;

The returned result filtered by the indicator is returned.

Here, when the API interface is preset to require index filtering, the return result obtained by directly executing the API interface call may be returned, or the return result obtained by executing the API interface call after the authentication is invoked may be filtered by the indicator. Go back.

Before performing metric filtering, determine whether metric filtering is required.

When the metric filtering is not required, the return result after the execution of the application interface call is directly returned.

Here, when the API interface is preset to not require index filtering, the return result obtained by directly executing the API interface call may be returned, or the return result obtained by executing the API interface call after the authentication is invoked may be not filtered. , return directly and end the entire process.

Optionally, the method further includes:

Adding the annotation information to the application interface;

Create a class that processes the annotation information. Preferably, the class that processes the annotation information can be created in a face-oriented manner.

Here, the annotation information is added in advance using the Annotation mechanism provided by the Java language, and the annotation information added by the Annotation does not affect the execution logic of the existing code. The aspect-oriented approach refers to AOP (Aspect Oriented Programming), a technique for achieving unified maintenance of program functions through precompilation and runtime dynamic agents. The classes used to process annotation information are newly added and do not require changes to the concrete implementation logic of the existing application interface.

2 is a flow chart showing an application interface management method according to still another aspect of the present application. As shown in FIG. 2, the application interface calling method includes:

Step S201, adding the annotation information to the application interface.

Here, the annotation information is added by the Annotation mechanism provided by the Java language, and the annotation information added by the Annotation does not affect the execution logic of the existing code. The annotation information includes the call authentication information and the indicator filtering information. In addition, it may also include information on whether interface management is required, for example, whether the API authentication interface needs to be invoked, or whether the API interface needs to be invoked. Returns the result for metric filtering. The call authentication information may include information such as an authentication processing object, and the indicator filtering information may include information such as an indicator filtering object. Here, the indicator can refer to the data category returned by the interface calling the API interface.

Step S202, creating a class for processing the annotation information.

Here, the class that processes the annotation information can be created in a face-oriented manner, and the aspect-oriented approach refers to the AOP mode. The classes used to process annotation information are newly added and do not require changes to the concrete implementation logic of the existing application interface.

Step S203, intercepting the calling request of the application interface and acquiring the annotation information of the application interface.

Here, the service requester, the API interface caller, initiates the call request. The AOP intercepts the call request and parses the Annotation annotation information that has been added by the API interface to obtain the data information required for subsequent API interface call management.

In step S204, it is determined whether call authentication needs to be performed.

Here, the judgment is made based on whether or not information required for interface management is included in the annotation information. For example, it is determined based on whether or not the information to be called for authentication is set in advance to the API interface.

Step S205, when the call authentication is not required, the call to the application interface is directly executed.

Here, if it is not necessary to perform call authentication for the call of the API interface, the caller of the API interface does not perform call authentication and directly executes the API interface call. After the API interface is invoked and the returned result is obtained, the process may go to step S209 to determine whether it is necessary to perform index filtering on the returned result.

Step S206: When the call authentication needs to be performed, call the authentication request according to the call authentication information.

Here, the call authentication is divided into two kinds of results, the call authentication is passed, and the process jumps to step S208 for processing; the call authentication is not passed, for example, the identity of the caller does not comply with the call permission of the API interface, and the jump is performed at this time. The process proceeds to step S207.

Step S207: When the call authentication fails, the error prompt information is returned.

Here, according to the return value type, the error message is wrapped and returned directly to the end of the process.

Step S208, after the call authentication is passed, perform a call to the application interface.

Here, the identity of the caller conforms to the call permission setting of the API interface, and the call authentication is allowed to pass. After the API interface is called and the returned result is obtained, the process proceeds to step S209 to determine.

In step S209, it is determined whether index filtering is required.

Here, the judgment is made based on whether or not information required for interface management is included in the annotation information. For example, it is determined based on whether or not the information required to be filtered by the API interface is set in advance. The judgment is divided into two kinds of results, and the indicator filtering is not required, and the process proceeds to step S210 for processing; the indicator filtering is required, and the process proceeds to step S211 for processing.

In step S210, when the indicator filtering is not required, the return result after the execution of the call is directly returned.

Here, when the API interface is preset to not require index filtering, the return result obtained by directly executing the API interface call in step S205, or the return result obtained by executing the API interface call after the authentication is passed in step S208, Without metric filtering, go straight back and end the entire process.

In step S211, when the indicator filtering needs to be performed, the indicator filtering is performed on the returned result after the call is performed according to the indicator filtering information.

In step S212, the returned result filtered by the indicator is returned.

Here, when the API interface is preset to require index filtering, the return result obtained by directly executing the call of the API interface in step S205, or the return result obtained by executing the API interface call after calling the authentication in step S208, After the metrics are filtered and then returned and the entire process is ended, the metric granularity of the returned metrics can be controlled according to the identity of the caller.

Through the application interface management method of the present application, it is only necessary to add annotation information to the existing interface, and correspondingly Into the extra processing logic class, you can achieve different granularity of interface management for each interface that is open without modifying the existing logic.

FIG. 3 shows a schematic structural diagram of an application interface management apparatus according to an aspect of the present application. As shown in FIG. 3, the application interface management apparatus 3 includes an interception module 31, an acquisition module 32, and an invocation management module 33.

The intercepting module 31 is configured to intercept a call request to the application interface, and the obtaining module 32 is configured to obtain the annotation information of the application interface, and the calling management module 33 is configured to perform, according to the annotation information and the calling request The call of the application interface is managed.

Here, the intercepting module 31 intercepts the call request sent by the caller to the API interface, and sends it to the call management module 33 for processing; the obtaining module 32 acquires the pre-added annotation information from the API interface, and sends the annotation information to the call management module 33. deal with. The API interface is pre-added with annotation information, such as Annotation annotation information provided by the Java language, and the annotation information includes management information for calling the API interface, such as management information for calling authentication and index filtering. The call management module 33 performs call authentication management according to the call authentication information in the annotation information, performs identity control on the caller of the API interface, that is, the service user, or returns the information to the API interface according to the index filtering information in the annotation information. The granularity of the indicators is controlled and managed.

The application interface management device of the present application does not need to change the existing code or modify the logic of the code main body on a large scale, and only needs to manage the code through the independently added application interface, and can process the call to each application interface according to the annotation information. Management, thereby reducing the value overhead of code maintenance, such as avoiding service failures due to changes in the subject logic.

FIG. 4 shows a schematic structural diagram of an application interface management apparatus according to still another aspect of the present application. As shown in FIG. 4, the application interface management apparatus 4 includes: an interception module 31, an acquisition module 32, and an invocation management module 33 shown in FIG. 3, and an annotation module 41 and a processing class module 42.

Here, the intercepting module 31 intercepts the call request sent by the caller to the API interface, and sends it to the call management module 33 for processing; the obtaining module 32 acquires the pre-added annotation information from the API interface, and sends the annotation information to the call management module 33. deal with.

The annotation module 41 is configured to add the annotation information to the application interface.

Here, the annotation information does not affect the execution logic of the existing code. The annotation information includes the call authentication information and the indicator filtering information, and may also include information about whether interface management is required, for example, whether it is necessary The API interface performs information for invoking authentication, or whether it needs to perform index filtering on the returned result of calling the API interface. The call authentication information may include information such as an authentication processing object, and the indicator filtering information may include information such as an indicator filtering object. Here, the indicator can refer to the data category returned by the interface calling the API interface.

The processing class module 42 is configured to create a class that processes the annotation information. Preferably, the processing class module 42 is further configured to: create a class that processes the annotation information in a face-oriented manner.

Here, the class used to process the annotation information is newly added, and there is no need to change the concrete implementation logic class of the existing application interface.

Further, the call management module 33 further includes: an authentication module 331, an execution calling module 332, and a first determining module 333.

The authentication module 331 is configured to perform call authentication on the call request according to the call authentication information. The authentication module 331 is further configured to: return an error prompt message when the call authentication fails.

The execution invoking module 332 is configured to execute a call to the application interface after the call authentication is passed. The execution invocation module 332 is further configured to directly perform a call to the application interface when call authentication is not required.

The first determining module 333 is configured to determine whether the call authentication needs to be performed before the call authentication is performed.

Here, when the call authentication is not required, the first determining module 333 notifies the execution calling module 332 to directly execute the call to the application interface; when the call authentication needs to be performed, the first determining module 333 notifies the authentication module 331 to make the call. After the authentication is passed, the authentication module 331 notifies the execution calling module 332 to execute the API interface call; when the calling authentication fails, the authentication module 331 directly returns the error prompt information according to the return value type.

Further, the call management module 33 further includes: an index filtering module 334, a return module 335, and a second determining module 336.

The metric filtering module 334 is configured to perform metric filtering on the return result after the application interface is invoked according to the metric filtering information.

The returning module 335 is configured to return the returned result filtered by the indicator. The returning module 334 is further configured to: directly return a return result after the execution of the application interface call when the indicator filtering is not required.

The second determining module 336 is configured to determine whether the indicator filtering needs to be performed before performing the indicator filtering;

When the metric filtering is not required, the second determining module 336 notifies the returning module 334 to directly return the return result obtained by the execution calling module 332. When the indicator filtering needs to be performed, the second determining module 336 passes The knowledge indicator filtering module 334 performs index filtering on the return result obtained by the execution calling module 332, and the return module 334 returns the returned result processed by the index filtering module 334. The return result of the execution call module 332 can be obtained by directly executing the API interface call, or by calling the API interface call after the authentication is passed.

Through the application interface management device of the present application, it is only necessary to add annotation information to the existing interface, and correspondingly introduce additional processing logic classes, so that each application opened to the public can be realized without modifying the existing logic. Interfaces perform interface management at different granularities.

It should be noted that the present application can be implemented in software and/or a combination of software and hardware, for example, using an application specific integrated circuit (ASIC), a general purpose computer, or any other similar hardware device. In one embodiment, the software program of the present application can be executed by a processor to implement the steps or functions described above. Likewise, the software programs (including related data structures) of the present application can be stored in a computer readable recording medium such as a RAM memory, a magnetic or optical drive or a floppy disk and the like. In addition, some of the steps or functions of the present application may be implemented in hardware, for example, as a circuit that cooperates with a processor to perform various steps or functions.

In addition, a portion of the present application can be applied as a computer program product, such as computer program instructions, which, when executed by a computer, can invoke or provide a method and/or technical solution in accordance with the present application. The program instructions for invoking the method of the present application may be stored in a fixed or removable recording medium, and/or transmitted by a data stream in a broadcast or other signal bearing medium, and/or stored in a The working memory of the computer device in which the program instructions are run. Herein, an embodiment in accordance with the present application includes a device including a memory for storing computer program instructions and a processor for executing program instructions, wherein when the computer program instructions are executed by the processor, triggering The apparatus operates based on the aforementioned methods and/or technical solutions in accordance with various embodiments of the present application.

It is obvious to those skilled in the art that the present application is not limited to the details of the above-described exemplary embodiments, and the present invention can be implemented in other specific forms without departing from the spirit or essential characteristics of the present application. Therefore, the present embodiments are to be considered as illustrative and not restrictive, and the scope of the invention is defined by the appended claims instead All changes in the meaning and scope of equivalent elements are included in this application. Any reference signs in the claims should not be construed as limiting the claim. In addition, it is to be understood that the word "comprising" does not exclude other elements or steps. A plurality of units or devices recited in the device claims may also be implemented by a unit or device by software or hardware. The first, second, etc. words are used to denote names and do not denote any particular order.

Claims

An application interface management method, wherein the method comprises:

Intercepting a call request to an application interface;

Obtaining annotation information of the application interface;

The call of the application interface is managed according to the annotation information and the call request.
The method of claim 1 wherein said annotation information comprises invoking authentication information;

The managing the call of the application interface according to the annotation information and the calling request further includes:

Performing call authentication on the call request according to the call authentication information;

After the call authentication is passed, a call to the application interface is performed.
The method of claim 2, wherein managing the call of the application interface according to the annotation information and the call request further comprises:

When the call authentication fails, an error message is returned.
The method of claim 2, wherein managing the call of the application interface according to the annotation information and the call request further comprises:

Before calling the authentication, it is determined whether the call authentication needs to be performed;

When the call authentication is not required, the call to the application interface is directly executed.
The method of claim 1, wherein the annotation information further comprises indicator filtering information;

The managing the call of the application interface according to the annotation information and the calling request further includes:

Performing index filtering on the returned result after the execution of the application interface is performed according to the indicator filtering information;

The returned result filtered by the indicator is returned.
The method of claim 5, wherein managing the call of the application interface according to the annotation information and the call request further comprises:

Before performing metric filtering, determine whether metric filtering is required.

When the metric filtering is not required, the return result after the execution of the application interface call is directly returned.
The method of any of claims 1 to 6, wherein the method further comprises:

Adding the annotation information to the application interface;

Create a class that processes the annotation information.
The method of claim 7 wherein said creating a class to process said annotation information further comprises:

A class that processes the annotation information is created in a face-oriented manner.
An application interface management device, wherein the device comprises:

An interception module for intercepting a call request to an application interface;

An obtaining module, configured to obtain annotation information of the application interface;

Calling a management module, configured to manage the call of the application interface according to the annotation information and the call request.
The apparatus of claim 9, wherein the annotation information comprises invoking authentication information;

The call management module further includes:

An authentication module, configured to perform call authentication on the call request according to the call authentication information;

Executing a calling module, configured to perform a call to the application interface after the call authentication is passed.
The device according to claim 10, wherein the authentication module is further configured to:

When the call authentication fails, an error message is returned.
The device of claim 10, wherein the call management module further comprises:

a first determining module, configured to determine whether call authentication is required before performing call authentication;

The execution invoking module is further configured to directly perform a call to the application interface when call authentication is not required.
The apparatus according to claim 9, wherein said annotation information further comprises indicator filtering information;

The call management module further includes:

An metric filtering module, configured to perform metric filtering on a return result after the application interface is invoked according to the metric filtering information;

A return module is used to return the returned result filtered by the indicator.
The device of claim 13, wherein the call management module further comprises:

The second determining module is configured to determine whether the indicator filtering needs to be performed before performing the indicator filtering;

The returning module is further configured to directly return a return result after the execution of the application interface call when the indicator filtering is not required.
The device according to any one of claims 9 to 14, wherein the device further comprises:

Adding an annotation module, configured to add the annotation information to the application interface;

A processing class module for creating a class that processes the annotation information.
The apparatus of claim 15, wherein the processing class module is further configured to:

A class that processes the annotation information is created in a face-oriented manner.