index.md

CommonPHP API Documentation

CommonPHP API is the JSON surface layer for CommonPHP applications. It mounts API routes, adapts HTTP requests into API requests, dispatches action handlers, normalizes action return values, and turns expected failures into JSON problem responses.

The package is deliberately small. HTTP primitives stay in comphp/http, route matching stays in comphp/router, and reusable input validation stays in comphp/validation.

Start Here

• Getting started
• Usage
• Package boundaries

API Concepts

• Architecture
• Requests
• Responses
• Routing and actions
• Problem responses
• Error handling

Examples

• Examples index
• Basic API surface
• Action class
• Validation errors

Development

• Testing and QA

Public API Map

Entry points:

• CommonPHP\API\ApiSurface
• CommonPHP\API\ApiRequest
• CommonPHP\API\ApiResponseFactory
• CommonPHP\API\ApiExceptionHandler

Response objects:

• CommonPHP\API\JsonResponse
• CommonPHP\API\ApiProblem
• CommonPHP\API\ApiProblemResponse

Contracts:

• CommonPHP\API\Contracts\ActionInterface
• CommonPHP\API\Contracts\AbstractAction
• CommonPHP\API\Contracts\ApiResponseInterface

Enums:

• CommonPHP\API\Enums\ApiStatus

Exceptions:

• CommonPHP\API\Exceptions\ApiException
• CommonPHP\API\Exceptions\InvalidActionException
• CommonPHP\API\Exceptions\UnsupportedContentTypeException