Page History
...
First, we need to run the HTTP Framework Setup form (e.g., EXEC NDW_HTTP_FRAMEWORK_SETUP from the System Monitor) and then click on the Resources menu to open the Resource Manager:
When creating an API you are either creating a new resource coupled with one or more supported HTTP methods or you are updating an existing resource by adding new supported HTTP methods. The below documentation creates an API for new resource but the process of creating an API for an updated resource is very similar.
Let's plan on creating a customers resource with an endpoint of /api/customers. Since this resource is directly underneath our /api endpoint, we start by selecting the api resource item in the Resource Manager tree (which is already demonstrated in the above screenshot). We then click on the New Resource button, type customers in the prompt, and finish by pressing the Enter key:
This defines the resource within the SRP HTTP Framework environment but it does not yet create the API. This requires two more actions. First, click on one or more methods to support. For now we'll just click on the GET method. Second, click on the Create APIs button. If successful, the following message will appear:
A new stored procedure (aka API module) will be added to your repository and this can be opened with any code editor (we recommend using the SRP Editor because of its native support for enhanced BASIC+ syntax, such as the API keyword). API modules are named after the resource using this pattern: <ResourceName>_API. Thus, since our resource is named "customers", we will look for a stored procedure named CUSTOMERS_API. It should look like this:
...
When new APIs are defined, the SRP HTTP Framework automatically adds a call to the LoremIpsum service (a member of the HTTP_Resource_Services module). This provides functionality for the API so that the endpoint can be tested immediately. For instance, we can now use an API test utility like Postman to make a request:
Note, the above API was tested with the default credentials. If you are not sure how credentials are handled then please read the How do I authenticate my API? article.
