joy/nova-api

This Laravel/Nova module adds REST Api with swagger support to Nova.

v1.0.0 2022-09-06 01:37 UTC

Requires

• php: ^8.0.2
• cebe/php-openapi: ^1.5
• darkaonline/l5-swagger: ^7.0|^8.0
• illuminate/support: ^7|^8|^9
• joy/nova-core: ^1.0
• laravel/nova: ^4.8

Requires (Dev)

• ext-pdo_sqlite: *
• ext-zip: *
• friendsofphp/php-cs-fixer: ^3.0
• guzzlehttp/guzzle: ^6.3|^7.0
• mockery/mockery: ^1.3
• orchestra/testbench: ^5.0|^6.0|^7.0
• phpunit/phpunit: ^9.1

MIT

• Ramakant Gangwar

• api
• cms
• nova
• laravel
• swagger
• swagger-ui
• joy
• nova-api
• joy-nova-api

README

This Laravel/Nova module adds REST Api with Passport and Swagger support to Nova.

By 🐼 Ramakant Gangwar.

Prerequisites

• Composer Installed
• Install Laravel
• Install Nova

Installation

# 1. Require this Package in your fresh Laravel/Nova project
composer require joy/nova-api

# 2. Publish
php artisan vendor:publish --provider="Joy\NovaApi\NovaApiServiceProvider" --force

# 3. Generate Swagger Docs Json
php artisan joy-nova-api:l5-swagger:generate

Working Example

You can try laravel demo here https://joy-nova.herokuapp.com/api/documentation.

Documentation

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the joy nova-api? Feel free to create an issue on GitHub, we'll try to address it as soon as possible.

If you've found a bug regarding security please mail [e-mail] instead of using the issue tracker.

Testing

You can run the tests with:

vendor/bin/phpunit

Upgrading

Please see UPGRADING for details.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

• Ramakant Gangwar

License

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