railroad/musora-api

v4.0.2 2024-10-09 12:54 UTC

Requires

• php: ^8.2
• intervention/image: ^2.0
• laravel/framework: ^11.9
• railroad/ecommerce: 6.0.*
• railroad/permissions: 3.0.*
• railroad/railcontent: 3.0.*
• railroad/response: 3.0.*

Requires (Dev)

• orchestra/testbench: ^9.2
• phpunit/php-code-coverage: ^11.0.1
• phpunit/phpunit: ^11.0.1

MIT

README

API for musora websites

• Install
• API Endpoints
  • Guest Endpoints
  • Endpoints that require Authentication

Install

1. Install via composer:

composer require railroad/musora-api:1.0

1. Add service provider to your application laravel config app.php file:

use Railroad\MusoraApi\Providers\MusoraApiServiceProvider;'providers' => [
    
    // ... other providers
     MusoraApiServiceProvider::class,
],

1. Publish the musora-api config file:

php artisan vendor:publish

1. Define middlewares, response structure and emails messages in musora-api.php config file( e.g.: Drumeo file)

2. Create chat, user and product providers ( e.g: MusoraApiChatProvider , MusoraApiUserProvider , MusoraApiProductProvider)

3. In AppServiceProvider boot method create instance for the providers:

        app()->instance(ProductProviderInterface::class, app()->make(MusoraApiProductProvider::class));
        app()->instance(ChatProviderInterface::class, app()->make(MusoraApiChatProvider::class));
        app()->instance(UserProviderInterface::class, app()->make(MusoraApiUserProvider::class));

API Endpoints

Guest Endpoints

Endpoints that require Authentication