bear/api-doc

1.3.0 2024-06-09 11:43 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-filter: *
• ext-json: *
• ext-libxml: *
• ext-simplexml: *
• bear/app-meta: ^1.7
• bear/package: ^1.9
• bear/resource: ^1.16.2
• bear/sunday: ^1.4
• doctrine/annotations: ^1.12 || ^2.0
• koriym/app-state-diagram: ^0.11
• koriym/psr4list: ^1.0.1
• michelf/php-markdown: ^1.9.1 || ^2.0
• phpdocumentor/reflection-docblock: ^4.3 || ^5.2
• ray/aop: ^2.10
• ray/di: ^2.16
• rize/uri-template: ^0.3.3

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8.2
• bear/aura-router-module: ^2.0.3
• koriym/attributes: ^1.0.5
• phpunit/phpunit: ^9.6.15
• rector/rector: ^1.1

MIT

• Akihito Koriyama

README

BEAR.ApiDoc generates API documentation from the application.

The documentation generated from the application's method signatures, phpdoc, and JSON Shcema will match the API documentation and the actual application.

This not only saves you the trouble of writing IDL, but also allows you to generate accurate documentation.

Installation

composer require bear/api-doc ^1.0

Usage

See the API doc documentatiom.