Skip to content

ECWebServices/ecdocs

Repository files navigation

Simple API Documentation for Laravel

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

ECDocs is an API Documentation generator, based on dedoc/scramber. The only reason this package exists is so that way I can make the same package, but make sure that it's updated at a timely manner, and to make sure that I can add any extra features that I want to have in the original version.

Installation

You can install the package via composer:

composer require elijahcruz/ecdocs

You can publish and run the migrations with:

php artisan vendor:publish --tag="ecdocs-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="ecdocs-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="ecdocs-views"

Usage

$ecdocs = new ECDoc\Ecdocs();
echo $ecdocs->echoPhrase('Hello, ECDoc!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Create API documentation, without lifting a finger

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published