2017 © Pedro Peláez
 

library laravel-api-docs-generator

Generate beautiful API documentation from your Laravel application

image

autaut03/laravel-api-docs-generator

Generate beautiful API documentation from your Laravel application

  • Thursday, January 4, 2018
  • by autaut03
  • Repository
  • 1 Watchers
  • 0 Stars
  • 5 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 400 % Grown

The README.md

[WIP] Laravel API documentation generator

Latest Stable Version Downloads Travis Build StyleCI PHP Eye Scrutinizer Code Quality codecov Dependency Status License, (*1)

BETA VERSION

NO HTML GENERATION AVAILABLE YET., (*2)

Automatically generate your API documentation from your existing Laravel routes. No example available for now., (*3)

Installation

Require this package with composer using the following command:, (*4)

$ composer require autaut03/laravel-api-docs-generator

Using Laravel < 5.5? Go to your config/app.php and add the service provider:, (*5)

AlexWells\ApiDocsGenerator\PackageServiceProvider::class,

Publish vendor

If you want to modify HTML template or make some changes to the assets (img, css, js) then publish vendor files:, (*6)

$ php artisan vendor:publish

After that views and assets will appear inside resources/vendor/api-docs directory and will be used instead of default., (*7)

Usage

To generate your API documentation, use the api-docs:generate artisan command., (*8)

$ php artisan api-docs:generate -m="api/v2/*" -m="non-api/another" -m="manual/{p}"

Use -h flag to get a list of available options, (*9)

How does it work?

This package uses these resources to generate the API documentation:, (*10)

TODO: use test cases & test fixtures as examples for now.

The Versions

04/01 2018

dev-master

9999999-dev http://github.com/autaut03/laravel-api-docs-generator

Generate beautiful API documentation from your Laravel application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Oleksandr Prypkhan

laravel api documentation

04/01 2018

dev-analysis-zYxNnY

dev-analysis-zYxNnY http://github.com/autaut03/laravel-api-docs-generator

Generate beautiful API documentation from your Laravel application

  Sources   Download

MIT

The Requires

 

The Development Requires

by Oleksandr Prypkhan

laravel api documentation