Tracking application programming interface requests in a cloud computing system
Techniques are provided for tracking application programming interface (API) requests in a cloud computing environment. For example, a method for tracking API requests is implemented by an API gateway. The API gateway receives an API request which comprises a given API endpoint to access a target service of a computing system. The API gateway determines if the received API request is valid. In response to determining that the received API request is valid, the API gateway accesses at least one API counter associated with the given API endpoint of the received API request, wherein the at least one API counter is configured to count a number of times that the given API endpoint is accessed. The API gateway increments a count of the at least one API counter by one, and the API gateway routes the API request to the target service for execution.
1. A method, comprising:
receiving, by an application programming interface (API) gateway, an API request which specifies a given API endpoint to access a target service of a computing system;
determining, by the API gateway, whether the received API request is a valid API request for accessing the target service by at least determining whether the given API endpoint is a permitted API endpoint associated with the target service; and
responsive to determining that the received API request is valid;
accessing, by the API gateway, at least one API counter associated with the given API endpoint of the received API request, wherein the at least one API counter is configured to count a number of times that the given API endpoint is accessed;
incrementing a count of the at least one API counter by one; and
routing, by the API gateway, the API request to the target service for execution.
2. The method of claim 1 , wherein accessing the at least one API counter comprises accessing, by the API gateway, a set of API counters associated with the given API endpoint, wherein the set of API counters comprises a first counter that is configured to count the number times that a base API endpoint of the given API endpoint is accessed, and at least a second counter that is configured to count a number of times that a variation of the base API endpoint is accessed.
3. The method of claim 2 , wherein the variation of the base API endpoint comprises the base API endpoint with an added header parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added header parameter is accessed.
4. The method of claim 2 , wherein the variation of the base API endpoint comprises the base API endpoint with a non-default method, wherein the second counter is configured to count a number of times that the base API endpoint with the non-default method is accessed.
5. The method of claim 2 , wherein the variation of the base API endpoint comprises the base API endpoint with an added query parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added query parameter is accessed.
6. The method of claim 2 , wherein the variation of the base API endpoint comprises the base API endpoint with an added path parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added path parameter is accessed.
7. The method of claim 1 , wherein determining, by the API gateway, whether the received API request is a valid API request for accessing the target service by at least determining whether the given API endpoint is a permitted API endpoint associated with the target service, comprises comparing the given API endpoint specified in the received API request to a whitelist of permitted API endpoints associated with registered microservices of the computing system.
8. The method of claim 1 , wherein accessing, by the API gateway, at least one API counter associated with the given API endpoint of the received API request comprises:
determining, by the API gateway, a counter group associated with an entity that issued the API request; and
accessing, by the API gateway, the at least one API counter associated with the given API endpoint of the received API request, which is included in the determined counter group.
9. The method of claim 8 , wherein the counter group is associated with an automation test performed by a system integration testing tool.
10. The method of claim 8 , wherein the counter group is associated with a registered end-user of the computing system.
11. An article of manufacture comprising a non-transitory processor-readable storage medium having stored therein program code of one or more software programs, wherein the program code is executable by one or more processors to implement a method comprising:
receiving, by an application programming interface (API) gateway, an API request which specifies a given API endpoint to access a target service of a computing system;
determining, by the API gateway, whether the received API request is a valid API request for accessing the target service by at least determining whether the given API endpoint is a permitted API endpoint associated with the target service; and
responsive to determining that the received API request is valid;
accessing, by the API gateway, at least one API counter associated with the given API endpoint of the received API request, wherein the at least one API counter is configured to count a number of times that the given API endpoint is accessed;
incrementing a count of the at least one API counter by one; and
routing, by the API gateway, the API request to the target service for execution.
12. The article of manufacture of claim 11 , wherein accessing the at least one API counter comprises accessing, by the API gateway, a set of API counters associated with the given API endpoint, wherein the set of API counters comprises a first counter that is configured to count the number times that a base API endpoint of the given API endpoint is accessed, and at least a second counter that is configured to count a number of times that a variation of the base API endpoint is accessed.
13. The article of manufacture of claim 12 , wherein the variation of the base API endpoint comprises the base API endpoint with an added header parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added header parameter is accessed.
14. The article of manufacture of claim 12 , wherein the variation of the base API endpoint comprises the base API endpoint with a non-default method, wherein the second counter is configured to count a number of times that the base API endpoint with the non-default method is accessed.
15. The article of manufacture of claim 12 , wherein the variation of the base API endpoint comprises the base API endpoint with an added query parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added query parameter is accessed.
16. The article of manufacture of claim 12 , wherein the variation of the base API endpoint comprises the base API endpoint with an added path parameter, wherein the second counter is configured to count a number of times that the base API endpoint with the added path parameter is accessed.
17. The article of manufacture of claim 11 , wherein accessing, by the API gateway, at least one API counter associated with the given API endpoint of the received API request comprises:
determining, by the API gateway, a counter group associated with an entity that issued the API request; and
accessing, by the API gateway, the at least one API counter associated with the given API endpoint of the received API request, which is included in the determined counter group;
wherein the counter group is associated with one of (i) an automation test performed by a system integration testing tool and (ii) a registered end-user of the computing system.
18. A server node, comprising:
at least one processor; and
system memory configured to store program code, wherein the program code is executable by the at least one processor to instantiate an application programming interface (API) gateway, wherein the API gateway is configured to:
receive an API request which specifies a given API endpoint to access a target service of a computing system;
determine whether the received API request is a valid API request for accessing the target service by at least determining whether the given API endpoint is a permitted API endpoint associated with the target service, and in response to determining that the received API request is valid;
access at least one API counter associated with the given API endpoint of the received API request, wherein the at least one API counter is configured to count a number of times that the given API endpoint is accessed;
increment a count of the at least one API counter by one; and
route the API request to the target service for execution.
19. The server node of claim 18 , wherein in accessing the at least one API counter, the API gateway is configured to access a set of API counters associated with the given API endpoint, wherein the set of API counters comprises a first counter that is configured to count the number times that a base API endpoint of the given API endpoint is accessed, and at least a second counter that is configured to count a number of times that a variation of the base API endpoint is accessed.
20. The server node of claim 18 , wherein in accessing the at least one API counter, the API gateway is configured to:
determine a counter group associated with an entity that issued the API request; and
access the at least one API counter associated with the given API endpoint of the received API request, which is included in the determined counter group;
wherein the counter group is associated with at least one of (i) an automation test performed by a system integration testing tool and (ii) a registered end-user of the computing system.