This article provides instructions on creating a resource that will be represented by a JSON object. Resources that need to be represented in other formats will be other articles. This article will also focus on creating a resource based on a database table. Since the SRP HTTP Framework ships with a sample CONTACTS database table, we'll use it our demonstration purposes. All of our examples will assume the following API is being called:
GET /contacts/1
Resources that are not based on data in a table can still use some of the principles presented below, but there will need to be a little more effort. We will provide additional articles to demonstrate how non-database resources can be created.
The Resource Object
We've already explained that a resource can be represented in any digital format, but the conventional format used by RESTful APIs is to use JSON. In our documentation we will often make reference to the resource object, which is short-hand for the "resource as represented by a serialized JSON object".
Have it Your Way
There are four basic methods for creating a resource within the SRP HTTP Framework. You will choose the method that best suits your needs. We will list the pros and cons of each method and provide sample code that creates the same resource using each method.
Method 1: Simple Automation
For simple database related resources, the GetDatabaseItem service (a member of the HTTP_Resource_Services module) can be used with minimal code:
API contacts.ID.GET
KeyID = EndpointSegment
HTTP_Resource_Services('GetDatabaseItem', 'CONTACTS', '', KeyID)
end api
This method is now deprecated, but there are no plans to remove it from the SRP HTTP Framework.
