yelner / apidocs

Swagger replacement tool built with VueJS & built for Laravel 😄

API Docs

This is where your description should go. Take a look at contributing.md to see a to do list.

Requirements

• Laravel 5.5 and above

Installation

Via Composer

$ composer require harlekoy/apidocs

After installing API Docs, publish its assets, and migration file using the apidocs:install Artisan command.

$ php artisan apidocs:install

Updating API Docs

When updating, you should re-publish API Docs's assets:

$ php artisan apidocs:publish

Usage

Access your API documentation in you browser

/apidocs/list

If you don't have any local server running in your machine, run this command first in you command line tool php artisan serve then it generate this http://127.0.0.1:8000. Now you can access the path with that hostname http://127.0.0.1:8000/apidocs/list enjoy using it 😄.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Harlequin Doyon
• All Contributors

License

license. Please see the license file for more information.