RESTful features of the Solodev API
When discussing the Solodev API, terms like “REST” and “RESTful” are often used. “REST” stands for Representational State Transfer. “REST” is an architectural style designed as an alternative to RPC or SOAP-based web services.
Although, there is no official REST standard, common approaches and best practices used across the engineering community define how RESTful APIs should work.
Solodev follows most of the practices and common definitions of the style. For example, Solodev API uses “resources” that are typically nouns such as Datatable or Calendar. Users can take action on resources using the standard HTTP methods and routes that reflect standard CRUD operations.
The Solodev API supports these HTTP methods for interacting with resources:
- Use a GET request to retrieve data. GET requests are safe and indempotent because they do not update or change user data.
- Use a POST request to create new endpoints and update existing ones.
- Use a DELETE request to remove a resource.
Resources are typically nouns (for e.g. Calendar and Datatable) that users can act on using GET, POST and DELETE HTTP methods.
Solodev documentation refers to endpoints. Endpoints are URIs for individual resources. For example, users can find a collection of calendars by executing a request against the /calendar/ endpoint.