PHPackages                             nicolas-cajelli/api-documenter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. nicolas-cajelli/api-documenter

ActiveLibrary[API Development](/categories/api)

nicolas-cajelli/api-documenter
==============================

0.1.0(8y ago)023MITPHPPHP >=7.1

Since Aug 14Pushed 8y agoCompare

[ Source](https://github.com/nicolas-cajelli/api-documenter)[ Packagist](https://packagist.org/packages/nicolas-cajelli/api-documenter)[ RSS](/packages/nicolas-cajelli-api-documenter/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

API documenter
==============

[](#api-documenter)

This library is intended to automatically build documentation with the smallest friction possible in a defined scope (see [Scope](#Scope)) If your use case doesn't match the current scope, please create an issue/pr

Scope
-----

[](#scope)

APIS running:

- Php 7.1 or higher (required by gson)
- Isolated Routes file with structure as [Slim framework](https://github.com/slimphp/Slim)

Install
-------

[](#install)

```
composer require nicolas-cajelli/api-documenter
```

Run (Default)
-------------

[](#run-default)

```
./vendor/bin/build-documentation src/routes.php "My api name" "/my/api/basepath"
```

Run (Custom)
------------

[](#run-custom)

Create a .php in your project:

```