Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Apivalk home page

Releases

Getting started

Intro
Configuration
Contributing
Deprecation & Upgrade
Installation
Support Policy Release Cycle

Concepts

Coding Standards
Request Lifecycle
Structure
Best OpenAPI/REST Practices

HTTP

Overview
Controller
Request
Response
Pagination
Filtering
Sorting
Localization

Resources

Resources
Defining a Resource
Resource Controllers
Resource Responses

Routing

Routing
Route
Router
Rate Limit

Cache

Overview
Filesystem & Custom Cache

Middleware

Middleware
Request Validation
Security Responsibilities
Authentication Middleware
Security Middleware
Rate Limit Middleware

Documentation (OpenAPI)

Overview
Docblock Generator
OpenAPI Generator
Property
Property Collection
Request
Response
Response Objects

Core System

Error Handling
Events
Util

Security

Overview
Identities
Authenticators

Customization

Customization

How-To Guides

How-To Guides
Configure Apivalk
Build a public endpoint: GET /health
Build a CRUD surface with a resource (Animal)
Build a full CRUD surface without resources
Model complex objects with PropertyCollection
Authenticate, authorize, and inspect identity
Authenticate with JWT (JWKS)
Authenticate with a custom API key header
Add filtering to a list endpoint
Add sorting to a list endpoint
Add pagination to a list endpoint
Add rate limiting
Write a custom middleware
Generate OpenAPI and request docblocks

API Standards

REST API Standards Overview
RESTful design and naming
Versioning and resource structure
Pagination, filtering, and sorting
Response format and status codes
Localization and internationalization

Main page

Apivalk home page

Main page
Main page

Getting started

Support Policy Release Cycle

Support Policy

All Apivalk major releases will …

Version	PHP	Support until
v1.x	7.2 - 8.4	January 2026
v2.x	7.2 - 8.4	August 2026

Release Cycle

Apivalk is…

Was this page helpful?

Coding Standards

Apivalk follows modern PHP standards and clean code principles to ensure the framework remains lightweight, predictable, and easy to extend

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Support Policy
Release Cycle