Skip to content

API Design Guidelines

Objective: Define standards for designing consistent, secure, versioned, and well-documented APIs (REST / OpenAPI), covering resource naming, HTTP semantics, request/response formats, versioning, security, and documentation.

Source File

View the full rule: .agent/rules/api-design.md

Sections

    1. REST Conventions
    1. HTTP Status Codes
    1. Request & Response Format
    1. Versioning & Compatibility
    1. Documentation, Security & Specification

Released under the MIT License.