Seamless restful API generation and consumption through a single channel
AssigneeOracle International Corporation
InventorsEduardo Ribeiro Rodrigues, Fabio de Souza, Wynne Chan
Life of this patent
Estimating the term…
Abstract
Techniques are disclosed for enabling seamless RESTful API generation and consumption through a single channel. Certain techniques are disclosed that allow for clients to both create an API and then immediately use or consume the API through a single channel of communication with a single component, such as a series of HTTP requests and/or responses sent between an application and an API Generation and Consumption (AGC) module.
Claims17
A method comprising:
- receiving, at a computing device, a first request to perform a first operation of defining a resource, wherein the computing device includes a API Generation and Consumption (AGC) module, the first request is received at the AGC module from an application over a single channel of communication, and the first request is destined to a first application programming interface (API) endpoint in the AGC module;
- creating, by the computing device, one or more instances of the resource using the resource definition in the first request;
- generating, by the computing device, one or more data structures for the resource using the first request;
- modifying, by the computing device, the first API endpoint that defines the resource to create a second API endpoint accessible to consume the resource;
- transmitting, by the computing device in response to the first request, a first response identifying the second API endpoint in the AGC module;
- receiving, at the computing device, a second request to perform a second operation for consuming the created one or more instances of the resource, wherein the second request is received at the AGC module from the application over the single channel of communication, the second request is destined to the second API endpoint, and wherein the second operation is a command to retrieve, update, add, or delete the one or more instances of the resource;
- performing, by the computing device using the generated one or more data structures, the command to retrieve, update, add, or delete the created one or more instances of the resource;
- transmitting, by the computing device in response to the second request, a second response indicating a result of the performing the command;
- and
- wherein the first request and the second request are implemented using a same protocol over the same single channel of communication.
A non-transitory computer readable storage medium storing instructions that, when executed by one or more processors of a computing device, cause the computing device to perform a method comprising:
- receiving, at the computing device, a first request to perform a first operation of defining a resource, wherein the computing device includes a API Generation and Consumption (AGC) module, the first request is received at the AGC module from an application over a single channel of communication, and the first request is destined to a first application programming interface (API) endpoint in the AGC module;
- creating, by the computing device, one or more instances of the resource using the resource definition in the first request;
- generating, by the computing device, one or more data structures for the resource using the first request;
- modifying;
- by the computing device;
- the first API endpoint that defines the custom resource to create a second API endpoint accessible to consume the resource;
- transmitting, by the computing device in response to the first request, a first response identifying the second API endpoint in the AGC module;
- receiving, at the computing device, a second request to perform a second operation for consuming the created one or more instances of the resource, wherein the second request is received at the AGC module from the application over the single channel of communication, the second request is destined to the second API endpoint, and the second operation is a command to retrieve, update, add, or delete the one or more instances of the resource;
- performing, by the computing device using the generated one or more data structures, the command to retrieve, update, add, or delete the created one or more instances of the resource;
- transmitting, by the computing device in response to the second request, a second response indicating a result of the performing the command;
- wherein the first request and the second request are implemented using a same protocol over the same single channel of communication.
A computing device, comprising:
- one or more processors;
- one or more network interfaces communicatively coupled with the one or more processors and configured to be communicatively coupled with a communications network;
- and a non-transitory computer readable storage medium communicatively coupled with the one or more processors and storing instructions that, when executed by the one or more processors of the computing device, cause the computing device to implement a method comprising:
- receiving, at the computing device, a first request to perform a first operation of defining a resource, wherein the computing device includes a API Generation and Consumption (AGC) module, the first request is received at the AGC module from an application over a single channel of communication, and the first request is destined to a first application programming interface (API) endpoint in the AGC module that creates metadata defining a resource, the first API endpoint having a first reference;
- creating, by the computing device, one or more instances of the resource using the resource definition in the first request;
- generating, by the computing device, a second API endpoint accessible to create one or more instances of the resource according to the metadata, the second API endpoint including at least the first reference;
- transmitting, by the computing device in response to the first request, a first response identifying the second API endpoint in the AGC module;
- receiving, at the computing device, a second request to perform a second operation for consuming the created one or more instances of the resource, wherein the second request is received at the AGC module from the application over the single channel of communication, the second request is destined to the second API endpoint, and the second operation is a command to retrieve, update, add, or delete the one or more instances of the resource;
- performing, by the computing device using the generated one or more data structures, the command to retrieve, update, add, or delete the created one or more instances of the resource;
- transmitting, by the computing device in response to the second request, a second response indicating a result of the performing the command,
- wherein the first request and the second request are implemented using a same protocol over the same single channel of communication.
Dependencies are inferred from the claim text.