ApiGen vs phpDocumentor: which is better for PHP 8.3?

ApiGen is more up-to-date with PHP 8.3 features like typed class constants and comprehensive phpDoc support, while phpDocumentor is older but has a larger ecosystem. Choose ApiGen for modern PHP projects, but phpDocumentor if you need extensive plugins.

How to customize ApiGen output themes?

Set themeDir in apigen.neon to a custom directory with Latte templates, as ApiGen uses Latte for rendering. There are no built-in theme options, so you'll need to create or modify templates manually.

Does ApiGen work with Docker in CI/CD pipelines?

Yes, the apigen/apigen Docker image allows easy integration by mounting volumes and specifying commands. This makes it suitable for automated documentation generation in pipelines without local PHP setup.

Can ApiGen handle PHP 8.2 readonly classes?

Yes, ApiGen fully supports PHP 8.2 features including readonly classes, DNF types, and constants in traits, as listed in its feature support from PHP 5.4 onward.

How to exclude internal tags in ApiGen?

Use the excludeTagged parameter in apigen.neon with tags like 'internal' to filter out class-likes and members marked with those phpDoc tags, keeping documentation focused on public APIs.

What's the memory usage for large projects?

Default memoryLimit is 512M, configurable via CLI or config. For very large codebases, you might need to increase this, as parallel processing can be memory-intensive depending on workerCount.

Open-Awesome

APIGen

NOASSERTIONPHPv7.0.0-alpha.6

A modern API documentation generator for PHP projects that supports all PHP 8.3 features.

Visit Website GitHub

2.2k stars307 forks0 contributors

What is APIGen?

ApiGen is a modern API documentation generator specifically designed for PHP projects. It automatically generates readable documentation from PHP source code, supporting all PHP 8.3 features and comprehensive phpDoc annotations. The tool helps developers create and maintain up-to-date API references for their PHP applications.

Target Audience

PHP developers and teams who need to generate and maintain API documentation for their PHP projects, particularly those using modern PHP versions (7.1 through 8.3).

Value Proposition

Developers choose ApiGen for its comprehensive support of modern PHP features, smart phpDoc parsing, and ease of use compared to manual documentation or less feature-complete alternatives.

Overview

PHP 7.1 ready Smart and Simple Documentation for your PHP project

Use Cases

Best For

Generating API documentation for PHP libraries and frameworks
Documenting PHP projects using modern features like enums and union types
Creating maintainable documentation for large PHP codebases
Teams needing automated documentation generation in CI/CD pipelines
PHP developers who want comprehensive phpDoc support
Projects requiring documentation that stays current with PHP language evolution

Not Ideal For

Projects requiring interactive API exploration or live documentation updates
Teams standardized on OpenAPI/Swagger for API specification
Environments with tight memory constraints (below 512MB per process)

Pros & Cons

Pros

Modern PHP Coverage

Supports all PHP features from 5.4 to 8.3, including enums, union types, and typed class constants, ensuring documentation stays current with PHP's evolution.

Advanced phpDoc Parsing

Integrates PHPStan's type system for handling generic classes, local type aliases, and comprehensive phpDoc annotations, providing accurate and detailed documentation.

Parallel Rendering Speed

Uses worker processes configurable via workerCount, significantly accelerating documentation generation for large codebases through parallel processing.

Flexible Configuration

Offers detailed settings in apigen.neon files for paths, exclusions, and output, allowing precise control over what gets documented and how.

Cons

Alpha Version Risks

Version 7.0 is marked as alpha, indicating potential bugs, breaking changes, or incomplete features, which may deter production use.

Limited Theme System

ThemeDir is optional with no built-in themes detailed, requiring manual effort for custom designs, which can be cumbersome for teams needing polished outputs.

NEON Configuration Hurdle

Relies on NEON format for configuration, less common than JSON or YAML, adding a learning curve for developers unfamiliar with Nette's syntax.

Frequently Asked Questions

Related Projects

swagger-php

A php swagger annotation and parsing library

Stars5,299

Forks940

Last commit1 month ago

Scramble

Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.

Stars2,104

Forks196

Last commit3 days ago

daux.io

Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

Stars826

Forks191

Last commit2 days ago

phpDox

A documentation generator for PHP projects (that is not limited to API documentation)

Stars0

Forks0

Last commit

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub