dingo/api
Api
This is a framework for building standardized RESTful APIs within Laravel and Lumen applications. It provides a structured environment for developing web services with integrated routing, request handling, and versioning.
The project distinguishes itself through a multi-adapter authentication system that validates identities via various schemes and third-party providers. It features a dedicated response transformation layer to convert raw database models into consistent output structures and an internal dispatcher that allows application logic to trigger API endpoints without external network calls.
The toolset covers broader API governance through versioning engines, rate limiting to prevent service abuse, and automated documentation generation. It also includes global exception mapping to return machine-readable error responses instead of system stack traces and header-based content negotiation to determine output formats.
Features
- REST API Frameworks - Acts as a comprehensive framework for building structured RESTful endpoints within Laravel and Lumen applications.
- RESTful API Development - Provides a framework for building standardized RESTful APIs with integrated routing and versioning for Laravel and Lumen.
- Response Transformers - Features a dedicated transformation layer to convert raw database models into consistent output structures.
- Authentication Adapters - Implements an adapter-based authentication system that routes credentials through interchangeable provider plugins.
- Multi-Provider Authentication - Supports multiple authentication schemes and third-party providers through a multi-adapter identity system.
- Version-Aware Route Dispatching - Directs requests to specific logic versions based on URL prefixes or headers to ensure backward compatibility.
- Data Transformation Layers - Utilizes a dedicated transformation layer to map raw database models to standardized API outputs.
- API Versioning - Implements strategies for managing multiple concurrent versions of an API to prevent breaking client integrations.
- Request and Response Transformers - Converts raw database models into consistent and formatted output structures before delivery to the client.
- API Documentation Generators - Provides tools for automated generation of structured technical documentation for API endpoints.
- Content Format Negotiation - Determines the response data format by matching client request headers against supported representations.
- Global Exception Handlers - Provides a centralized mechanism to catch system errors and map them to standardized machine-readable responses.
- Rate Limiting - Tracks request frequency per client via middleware to block traffic exceeding predefined thresholds.
- API Request Handling - Handles internal API requests to allow reuse of business logic without initiating external network calls.
- API Rate Limiting - Controls the number of requests a client can make within a timeframe to prevent service abuse.
- In-Process Request Dispatchers - Executes API endpoints within the application process to reuse business logic without network overhead.
- Exception Handling - Maps system exceptions to standardized, machine-readable API error responses to hide internal stack traces.
- HTTP Content Negotiation - Implements mechanisms to determine the preferred response representation based on HTTP request headers.
- Documentation Generation - Provides automated generation of structured API specifications to define endpoint behaviors for developers.
- API Development - Provides a toolkit for RESTful APIs.
- API Development - Toolkit for building RESTful APIs with versioning and rate limiting.
- API Frameworks - RESTful API package for Laravel and Lumen.
- Packages and Middleware - Listed in the “Packages and Middleware” section of the Awesome Lumen awesome list.
