Download the PHP package pomek/path2api without Composer
On this page you can find all versions of the php package pomek/path2api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download pomek/path2api
More information about pomek/path2api
Files in pomek/path2api
Download pomek/path2api
More information about pomek/path2api
Files in pomek/path2api
Vendor pomek
Package path2api
Short Description Path2API is a simple Laravel package which allows you generate API documentation based on phpDoc comments in your classes.
License MIT
Package path2api
Short Description Path2API is a simple Laravel package which allows you generate API documentation based on phpDoc comments in your classes.
License MIT
Please rate this library. Is it a good library?
Informations about the package path2api
Path2API
Path2API is a simple Laravel package which allows you generate API documentation based on phpDoc comments in your classes.
Package is compatible with Laravel 5.
Installation
- Add package to composer:
composer require "pomek/path2api:1.0.*"
- Publish configuration:
php artisan vendor:publish
- Edit configuration file:
config/path2api.php
- Add Service Provider to
app.php
:'Pomek\Path2API\Path2ApiServiceProvider'
- Artisan Command
path2api:generate
will be available now.
Configuration file
prefix
- API URL prefixfile
- where will save generated documentationbefore
- content will be added above the generated documentationafter
- content will be added below the generated documentationtemplate
- template for a single record
Example
-
Example Controller class:
-
Add resource to your
routes.php
-
Generate documentation by CLI command
- Your file
api.md
should be like:
All versions of path2api with dependencies
PHP Build Version
Package Version
Requires
illuminate/support Version
~5.0
illuminate/console Version ~5.0
illuminate/routing Version ~5.0
illuminate/filesystem Version ~5.0
illuminate/console Version ~5.0
illuminate/routing Version ~5.0
illuminate/filesystem Version ~5.0
The package pomek/path2api contains the following files
Loading the files please wait ....