The Wasabi AiR REST JSON API uses the REST architectural style to expose resources via HTTP requests, with JSON (JavaScript Object Notation) as the data format for request and response payloads. Key specifications include using standard HTTP methods (GET, POST, PUT, DELETE) to interact with resources, structuring URLs with nouns representing resources, and handling responses with appropriate HTTP status codes. JSON, being a lightweight and human-readable format, is ideal for data exchange in these APIs.
Core Concepts
RESTful Principles: REST (Representational State Transfer) APIs adhere to a set of architectural constraints, including uniform interface, statelessness, caching, a layered system, and client-server separation.
HTTP Methods
REST APIs use standard HTTP methods to perform actions on resources. Common methods include:
GET: Retrieves a resource.
POST: Creates a new resource.
PUT: Updates an existing resource.
DELETE: Deletes a resource.
Resource-Oriented Architecture
REST APIs focus on exposing resources (such as jobs, faces, etc.) as identifiable entities with unique URLs.
JSON Data Format
JSON is a widely used data format for REST APIs due to its lightweight and human-readable nature.