harlekoy/apidocs

Replacement for Swagger. It is built for Laravel

v0.8.0 2019-09-05 04:49 UTC

Requires

• illuminate/support: ~6
• laravel/framework: 5.7.*|5.8.*|6.0.*
• webpatser/laravel-uuid: ^3.0

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~7.0
• sempro/phpunit-pretty-print: ^1.0

MIT

• Harlequin Doyon

• api docs
• laravel

README

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

Reread API routes

When updating your API docs route list, you should run this command to get your latest Laravel route:list:

$ php artisan apidocs:routes

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

Road map

Laravel API Docs is still under development, I decided to ship it in this early stage so you can help me make it better. however, you can use it in production. Lets finish the task below so we can have a version 1 up and running with the right features needed.

Here's the plan for what's coming:

• Add support for API Docs custom path
• Add transition effect for groups and endpoints accordion
• Add a way to edit API Docs groups and endpoints in its the web interface
• Add tests.
• Add validation for required parameters

License

license. Please see the license file for more information.