2017 © Pedro Peláez
 

library laravel-api-doc-provider

Simple package for autogenerate API doc with Laravel framework

image

restio/laravel-api-doc-provider

Simple package for autogenerate API doc with Laravel framework

  • Monday, October 23, 2017
  • by mazahell
  • Repository
  • 1 Watchers
  • 13 Stars
  • 683 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 4 Forks
  • 0 Open issues
  • 10 Versions
  • 2 % Grown

The README.md

laravel-api-doc-provider

Simple API Doc generator based on Controller Annotations using with Laravel 5.2.* | 5.3.*, (*1)

Install by steps:, (*2)

Update your composer via command:

composer require restio/laravel-api-doc-provider

Add the service provider to the providers array in config/app.php

RestioDocProvider\RestioDocProvider::class,

Run artisan command:

php artisan clear-compiled
php artisan optimize

Publish vendor

php artisan vendor:publish

Configure

config/restio_doc.php, (*3)

Start annotate your Controllers (for ex. app\Http\Controllers\ExampleController.php)

About annotation

@route                example_index
@description          Example description for route
@required_params      [token]
@optional_params      [page]
  • @route - route name from RouteCollection
  • @description - short description about this route (ex. Main page, List of Users etc.)
  • @required_params - Required params (this params be marked with red star)
  • @optional_params - Optional params
  • token, page - params in app/Models/Doc.php

Write unitTest with write success response to json objects (for ex. tests/RestioExampleTest.php)

Run unit tests for generate success responses

php phpunit

After testing we must regenerate all API DOC with command

php artisan generate:docs

Enjoy!, (*4)

The Versions

23/10 2017

dev-master

9999999-dev

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

23/10 2017

v2.0.2

2.0.2.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

09/08 2017

v2.0.1

2.0.1.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

27/03 2017

v2.0.0

2.0.0.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

09/12 2016

v1.0.5

1.0.5.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

15/08 2016

v1.0.4

1.0.4.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

10/08 2016

v1.0.3

1.0.3.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

09/08 2016

v1.0.2

1.0.2.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

04/08 2016

v1.0.1

1.0.1.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator

01/08 2016

v1.0.0

1.0.0.0

Simple package for autogenerate API doc with Laravel framework

  Sources   Download

MIT

The Requires

 

laravel annotations provider apidoc autogenerator