dev-guide

Document setup, codegen, testing, and OpenAPI workflows for the ByJG PHP REST Reference Architecture.

17|7|Updated Sep 30, 2017

Search Tags:#testing #development #openapi #php #codegen #di #dev-guide

Ready to run

npx skills add https://github.com/byjg/php-rest-reference-architecture --skill dev-guide-byjg

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: dev-guide
Source: https://github.com/byjg/php-rest-reference-architecture/tree/main/.claude/skills/dev-guide
Command: npx skills add https://github.com/byjg/php-rest-reference-architecture --skill dev-guide-byjg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Development Guide provides a centralized reference for working with the byjg/php-rest-reference-architecture project, speeding up onboarding and reducing trial-and-error in daily development tasks.

Core Features & Use Cases

Comprehensive setup instructions for local development, including environment preparation and dependency management.
Code generation, scaffolding, and modification workflows for models, repositories, services, REST controllers, and DI configuration.
Guidance on testing, migrations, and keeping OpenAPI docs in sync with code, ensuring contract compliance in API changes.

Quick Start

Review this guide to set up your development environment and begin implementing features in the codebase.

Frequently Asked Questions about dev-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I set up a local development environment for a PHP REST architecture project?▼

To set up local development for a PHP REST architecture project, follow comprehensive environment preparation steps covering dependency management and configuration. This ensures your local workspace matches the reference architecture before implementing features.

What is the best way to generate code for models, repositories, and REST controllers in PHP?▼

The best way to generate code for models, repositories, and REST controllers is using dedicated codegen workflows. These scaffolding processes modify DI configurations and generate structural components across the PHP REST reference architecture.

How do I keep OpenAPI documentation in sync with code changes in a PHP REST project?▼

To keep OpenAPI documentation in sync with code changes, follow maintenance workflows that ensure contract compliance during API modifications. This guarantees your OpenAPI specs accurately reflect the current PHP REST implementation.

Does this PHP development guide cover testing approaches and database migrations?▼

Yes, the PHP development guide covers testing approaches and database migrations. It provides guidance on implementing tests and running migrations to maintain data integrity across the REST architecture project.

Can I use code generation to scaffold services and dependency injection configurations?▼

Yes, you can use code generation workflows to scaffold services and modify dependency injection configurations. The guide details how to generate and modify these components across the PHP REST reference architecture systematically.