zircote/swagger-php
Swagger Php
swagger-php ist ein OpenAPI-Spezifikationsgenerator und eine PHP-API-Dokumentationsbibliothek. Sie scannt PHP-Quellcode-Attribute und -Annotationen, um standardisierte Spezifikationsdateien und interaktive API-Referenzen zu erstellen.
Das Tool fungiert als Schema-Inferenz-Engine, die Datentypen und Schemata aus nativen PHP-Type-Hints und generischen Blöcken ableitet. Es verwendet reflexionsbasierte statische Analyse, um Metadaten zu extrahieren, ohne Anwendungslogik auszuführen, und unterstützt rekursive Schema-Vererbung, um Definitionen aus Elternklassen und Interfaces zusammenzuführen.
Das Projekt enthält ein CLI-Utility zum Exportieren von API-Definitionen in statische YAML- oder JSON-Dateien. Es bietet zudem eine Pipeline für die Spezifikationsassemblierung mit pluggbarer Verarbeitungslogik, um zu modifizieren, wie Quellcode analysiert oder strukturiert wird.
Features
- API Specification Generation - Automatically produces machine-readable API specifications based on endpoint metadata extracted from PHP source code.
- Metadata Inference - Automatically populates API metadata fields by analyzing native PHP type hints and code structure.
- Annotation-Driven Specification Generation - Scans source code for metadata markers to automatically generate standardized API specifications.
- OpenAPI Specification Generators - Generates YAML and JSON OpenAPI specification documents by scanning PHP code attributes and annotations.
- Automated API Documentation - Generates technical specifications and interactive documentation directly from PHP source code definitions.
- Schema Inference Engines - Derives API data types and schemas from native PHP type hints and generic blocks.
- Type-Hint-Based Schema Definitions - Leverages native PHP type hints and generic blocks to automatically define data structures and validation rules.
- Schema Type Inference - Automatically determines schema types by analyzing native PHP type hints and generic blocks.
- Complex Type Resolution - Infers detailed data schemas from native PHP type hints and generic blocks to minimize manual configuration.
- API Documentation Tools - Provides tools for generating and serving standardized API documentation and schema definitions from source code.
- PHP API Documentation Libraries - Provides a library for creating interactive API references by extracting metadata directly from PHP source code.
- API Definition Exporters - Converts API metadata extracted from PHP source code into structured formats like JSON and YAML for external use.
- CLI Specification Exporters - Provides a command-line utility to extract API specifications from source code into static files.
- Schema Components - Allows defining named entities in a central section and referencing them to prevent duplication in the specification.
- Schema Inheritance Resolution - Merges annotations from parent classes and interfaces into child schemas to maintain consistent API definitions.
- Specification Assembly Pipelines - Processes scanned metadata through a sequence of resolution steps to build a final standardized JSON or YAML document.
- Static Reflection - Inspects PHP code structure and attributes without executing the source code to extract metadata.
- Attribute Merging from Parent Classes - Merges attribute definitions from parent classes and interfaces into child objects to maintain a consistent definition hierarchy.
- PHP API Schema Modeling - Defines data structures and reusable components for web interfaces using native PHP type hints and class inheritance.
- Documentation - Generates OpenAPI documentation for REST APIs.
