RESTful APIs
This specification consolidates the guidelines for building, consuming, and documenting RESTful APIs on the Guardia platform. Its goal is to ensure standardization in responses and behaviors, promoting interoperability, traceability, and clarity for both internal and external consumers.
Guardia's REST APIs follow the standards defined by official HTTP protocol RFCs, with necessary adjustments to resolve potential ambiguities and adherence to Compliance by Design principles.
The RESTful specification is structured into reusable and versionable modules that cover the following aspects:
| Topic | Description |
|---|---|
| Status Codes | List of allowed HTTP status codes and usage rules. |
| Response Payloads | Unified format for success and error responses. |
| Pagination | Standard structure for navigating between paginated resources. |
| Sorting | Rules for using order_by and sort parameters. |
| Headers | Standard and custom headers used in APIs. |
IMPORTANT: All rules described here MUST be applied to any HTTP endpoint implemented on the platform, except for justified and documented exceptions in ADR.