# std-api

> API endpoint standards and conventions for RESTful design, naming, versioning, and HTTP status codes

- Author: Lilu Douglas
- Repository: devalexanderdaza/opencode-workflow
- Version: 20260114232758
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/devalexanderdaza/opencode-workflow
- Web: https://mule.run/skillshub/@@devalexanderdaza/opencode-workflow~std-api:20260114232758

---

---
name: std-api
description: API endpoint standards and conventions for RESTful design, naming, versioning, and HTTP status codes
---

## API endpoint standards and conventions

- **RESTful Design**: Follow REST principles with clear resource-based URLs and appropriate HTTP methods (GET, POST, PUT, PATCH, DELETE)
- **Consistent Naming**: Use consistent, lowercase, hyphenated or underscored naming conventions for endpoints across the API
- **Versioning**: Implement API versioning strategy (URL path or headers) to manage breaking changes without disrupting existing clients
- **Plural Nouns**: Use plural nouns for resource endpoints (e.g., `/users`, `/products`) for consistency
- **Nested Resources**: Limit nesting depth to 2-3 levels maximum to keep URLs readable and maintainable
- **Query Parameters**: Use query parameters for filtering, sorting, pagination, and search rather than creating separate endpoints
- **HTTP Status Codes**: Return appropriate, consistent HTTP status codes that accurately reflect the response (200, 201, 400, 404, 500, etc.)
- **Rate Limiting Headers**: Include rate limit information in response headers to help clients manage their usage