PHPackages                             pomek/path2api - 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. pomek/path2api

AbandonedArchivedLibrary[API Development](/categories/api)

pomek/path2api
==============

Path2API is a simple Laravel package which allows you generate API documentation based on phpDoc comments in your classes.

1.0.2(11y ago)065MITPHP

Since Apr 4Pushed 11y ago1 watchersCompare

[ Source](https://github.com/pomek/path2api)[ Packagist](https://packagist.org/packages/pomek/path2api)[ RSS](/packages/pomek-path2api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (6)Versions (4)Used By (0)

[![Build Status](https://camo.githubusercontent.com/a235603fb11c63b16076d6be8c7c25f34ba7efc3555674b19ef1fa54cd0ec26c/68747470733a2f2f7472617669732d63692e6f72672f706f6d656b2f70617468326170692e737667)](https://travis-ci.org/pomek/path2api)[![Total Downloads](https://camo.githubusercontent.com/a849f238f23d92fef4a7e0a1ac7ed85658d8927ba7ff3bd1dc002e4b82771ddc/68747470733a2f2f706f7365722e707567782e6f72672f706f6d656b2f70617468326170692f646f776e6c6f6164732e737667)](https://packagist.org/packages/pomek/path2api)[![License](https://camo.githubusercontent.com/992f9758553f5963040111a43413231b807bdf18955cdd62883f90022b8f2549/68747470733a2f2f706f7365722e707567782e6f72672f706f6d656b2f70617468326170692f6c6963656e73652e737667)](https://packagist.org/packages/pomek/path2api)

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
------------

[](#installation)

1. Add package to composer: `composer require "pomek/path2api:1.0.*"`
2. Publish configuration: `php artisan vendor:publish`
3. Edit configuration file: `config/path2api.php`
4. Add Service Provider to `app.php`: `'Pomek\Path2API\Path2ApiServiceProvider'`
5. Artisan Command `path2api:generate` will be available now.

Configuration file
------------------

[](#configuration-file)

- `prefix` - API URL prefix
- `file` - where will save generated documentation
- `before` - content will be added above the generated documentation
- `after` - content will be added below the generated documentation
- `template` - template for a single record

Example
-------

[](#example)

- Example Controller class:

```