Download the PHP package bear/api-doc without Composer
On this page you can find all versions of the php package bear/api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-doc
BEAR.ApiDoc
Your application is the documentation.
- ApiDoc HTML: Developer documentation
- OpenAPI 3.1: Tool chain integration
- JSON Schema: Information model
- ALPS: Vocabulary semantics for AI understanding
- llms.txt: AI-readable application overview
Semantic Depth
The same document reveals different insights depending on your perspective:
| Depth | What You See |
|---|---|
| Surface | Remote function list (API reference) |
| Middle | Resources and operations (REST design) |
| Deep | Application semantics (ALPS three layers) |
A developer sees endpoints to call. An architect sees state transitions. An AI extracts Ontology, Taxonomy, and Choreography. One document, multiple layers of understanding.
This is a semantic application document, not just an API reference. It describes what the application is, not just how to call it.
Demo
Installation
composer require bear/api-doc ^1.0Quick Start
Generate configuration file:
This creates apidoc.xml from your composer.json.
Generate documentation:
This writes the API documentation and its term usage index for human-readable formats, for example index.html and terms.html.
Generate the documentation quality report:
Each finding in the HTML audit carries a machine-readable findingType, so the report is a worklist, not just a list to read: the bear-audit-fix skill reads audit.html and closes the gaps it reports (PHPDoc summaries, JSON Schema, #[Alps]).
Usage
See the API doc documentation.
GitHub Actions
You can use the reusable workflow to generate and publish API documentation automatically.
Inputs
| Input | Default | Description |
|---|---|---|
php-version |
'8.2' |
PHP version |
format |
'html,openapi,llms' |
Comma-separated: html (apidoc), md, openapi, alps, llms, audit |
alps-profile |
'' |
ALPS profile path (required for alps format) |
docs-path |
'docs/api' |
Output directory |
publish-to |
'github-pages' |
github-pages or artifact-only |
Output Structure
Development
Application as Documentation.
All versions of api-doc with dependencies
ext-json Version *
ext-filter Version *
ext-simplexml Version *
ext-libxml Version *
ext-dom Version *
phpdocumentor/reflection-docblock Version ^5.2 || ^6.0
bear/resource Version ^1.16.2
bear/sunday Version ^1.4
bear/app-meta Version ^1.7
ray/di Version ^2.16
rize/uri-template Version ^0.3.3 || ^0.4
bear/package Version ^1.9
koriym/app-state-diagram Version ^0.11
michelf/php-markdown Version ^1.9.1 || ^2.0
koriym/psr4list Version ^1.0.1
ray/aop Version ^2.10
ray/input-query Version ^1.0