Apigility
A Zend Framework 2-based skeleton application for building and managing RESTful APIs with a web admin interface.
What is Apigility?
Apigility Skeleton is a starter application built on Zend Framework 2 for developing and managing RESTful APIs. It provides a structured foundation with a web-based admin dashboard to visually create, configure, and inspect APIs, streamlining the API development process without requiring a separate database for configuration.
PHP developers and teams using Zend Framework 2 who need a standardized, tool-assisted way to build and maintain RESTful APIs, particularly those who prefer a visual admin interface alongside code-driven configuration.
It offers a ready-to-use skeleton with integrated admin tools for API management, reducing initial setup time and providing a consistent development workflow. Its configuration-through-PHP-files approach ensures transparency and version control compatibility, while support for Docker and Vagrant aids environment consistency.
Overview
Apigility Skeleton is a foundational application for creating and managing RESTful APIs using the Zend Framework 2 ecosystem. It provides a structured starting point with built-in tools for API development, including a web-based admin dashboard for configuration and inspection.
Key Features
- Admin Dashboard — A web interface for creating, configuring, and inspecting APIs without manual file editing.
- RESTful API Builder — Tools to define REST resources, HTTP methods, and data transformations.
- Development Mode — Special mode enabling the admin interface and debugging tools, disabled in production.
- Configuration via PHP Files — API settings stored in PHP configuration files instead of a database.
- Built-in Web Server Support — Includes Composer aliases and instructions for using PHP's built-in web server during development.
- Docker and Vagrant Support — Pre-configured container and virtual machine setups for consistent development environments.
Philosophy
Apigility emphasizes a code-first, configuration-driven approach where APIs are defined through PHP files, prioritizing clarity and control while providing a visual admin tool for development convenience.
Use Cases
Best For
- Starting new RESTful API projects with Zend Framework 2
- Teams needing a visual admin interface for API configuration and inspection
- Developers who prefer PHP-based configuration over database-driven setups
- Projects requiring consistent development environments via Docker or Vagrant
- Building APIs where opcode caching is needed in production but disabled in development
- API development with built-in testing and code quality tooling
Not Ideal For
- New projects requiring active maintenance and security updates
- Teams using modern PHP frameworks like Laravel or Symfony
- Environments where opcode caching cannot be disabled during development
- Developers preferring database-driven configuration over PHP files
Pros & Cons
Pros
The web-based admin dashboard allows creating and configuring APIs without manual file editing, streamlining development workflow.
Enables debugging features and the admin interface via Composer commands, with easy toggling between development and production modes.
Includes pre-configured Docker and Vagrant files for reproducible development environments, reducing setup time and complexity.
Configuration stored in PHP files instead of a database makes changes easily trackable in Git, enhancing team collaboration.
Cons
The repository was moved in 2019 and is no longer maintained, posing risks for security vulnerabilities and compatibility with newer PHP versions.
The admin interface cannot run with opcode caches enabled, requiring manual disabling during development, which adds setup overhead and potential performance issues.
Requires setting AllowEncodedSlashes On in Apache vhost files, not in .htaccess, adding complexity for server configuration and deployment.
Built on Zend Framework 2, which is outdated compared to newer frameworks and the migrated Laminas project, limiting ecosystem support and modern features.
Frequently Asked Questions
Related Projects
FusioSelf-Hosted API Management for Builders
NegotiationContent Negotiation tools for PHP.
RestlerZero-boilerplate REST API framework for PHP 8+. Auto-generates routes, docs, validation.
HateoasA PHP library to support implementing representations for HATEOAS REST web services.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.