PHPackages                             unopim/bagisto-rest-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. unopim/bagisto-rest-api

ActiveLibrary[API Development](/categories/api)

unopim/bagisto-rest-api
=======================

v1.0.5(1mo ago)1916[2 PRs](https://github.com/unopim/bagisto-rest-api/pulls)MITPHPCI passing

Since Jan 21Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/unopim/bagisto-rest-api)[ Packagist](https://packagist.org/packages/unopim/bagisto-rest-api)[ RSS](/packages/unopim-bagisto-rest-api/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (6)Dependencies (4)Versions (7)Used By (0)

Bagisto REST API
================

[](#bagisto-rest-api)

Bagisto REST API is a medium to use the features of the core Bagisto system. By using the Bagisto REST API, you can integrate your application to serve the default content of Bagisto.

1. Requirements
---------------

[](#1-requirements)

- **Bagisto:** v2.4.x
- **PHP:** ^8.3

2. Installation
---------------

[](#2-installation)

### Option A — Composer (recommended)

[](#option-a--composer-recommended)

Install the package via Composer:

```
composer require unopim/bagisto-rest-api
```

### Option B — Manual (place the package in `packages/Webkul`)

[](#option-b--manual-place-the-package-in-packageswebkul)

Use this when you want to keep the package source inside your project (for example, a fork you maintain).

1. Put the package source in `packages/Webkul/RestApi`:

    ```
    git clone https://github.com/unopim/bagisto-rest-api.git packages/Webkul/RestApi
    rm -rf packages/Webkul/RestApi/.git
    ```
2. Register the namespace in the root `composer.json` under `autoload.psr-4`:

    ```
    "Webkul\\RestApi\\": "packages/Webkul/RestApi/src"
    ```
3. Register the service provider in `bootstrap/providers.php`:

    ```
    Webkul\RestApi\Providers\RestApiServiceProvider::class,
    ```
4. Install the L5-Swagger dependency and refresh the autoloader:

    ```
    composer require darkaonline/l5-swagger:^8.5
    composer dump-autoload
    ```

### Configure (both options)

[](#configure-both-options)

Add your application's domain to the `.env` file so Sanctum can authenticate stateful requests. Use the **host** only (optionally `host:port`) — do not include the scheme or path:

```
SANCTUM_STATEFUL_DOMAINS=localhost
```

Publish the L5-Swagger configuration and generate the API documentation:

```
php artisan bagisto-rest-api:install
```

> **Manual install only:** because the package lives in `packages/Webkul/RestApi` (not `vendor/`), open the published `config/l5-swagger.php` and change the annotation paths from `base_path('vendor/unopim/bagisto-rest-api/src/Docs/...')` to `base_path('packages/Webkul/RestApi/src/Docs/...')`, then regenerate the docs: `php artisan l5-swagger:generate --all`.

Clear the caches:

```
php artisan optimize:clear
```

3. API Documentation
--------------------

[](#3-api-documentation)

Open the following URLs in your browser (replace the host with your application's URL):

- **Admin:** `http://localhost/api/admin/documentation`
- **Shop:** `http://localhost/api/shop/documentation`

4. Bulk Product API (Queues)
----------------------------

[](#4-bulk-product-api-queues)

The Bulk Product API processes products asynchronously through the queue. Set the queue connection in your `.env`:

```
QUEUE_CONNECTION=database
```

Then run a queue worker so the dispatched bulk jobs are processed:

```
php artisan queue:work
```

> See the [L5-Swagger](https://github.com/DarkaOnLine/L5-Swagger) documentation for more details on configuring the API documentation.

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance89

Actively maintained with recent releases

Popularity16

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~103 days

Recently: every ~127 days

Total

6

Last Release

54d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/282263096?v=4)[navneetbhardwaj](/maintainers/navneetbhardwaj)[@NavneetBhardwaj](https://github.com/NavneetBhardwaj)

---

Top Contributors

[![rohitpal-webkul](https://avatars.githubusercontent.com/u/178137842?v=4)](https://github.com/rohitpal-webkul "rohitpal-webkul (17 commits)")[![navneetkumar-pim-webkul](https://avatars.githubusercontent.com/u/26001046?v=4)](https://github.com/navneetkumar-pim-webkul "navneetkumar-pim-webkul (13 commits)")[![dripar-webkul](https://avatars.githubusercontent.com/u/199071162?v=4)](https://github.com/dripar-webkul "dripar-webkul (7 commits)")

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/unopim-bagisto-rest-api/health.svg)

```
[![Health](https://phpackages.com/badges/unopim-bagisto-rest-api/health.svg)](https://phpackages.com/packages/unopim-bagisto-rest-api)
```

###  Alternatives

[badaso/core

The API &amp; platform builder, build your apps 10x faster even more, it's open source &amp; 100% free !

1.3k16.5k10](/packages/badaso-core)[bagisto/rest-api

28185.2k1](/packages/bagisto-rest-api)[joy/voyager-api

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

194.8k3](/packages/joy-voyager-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
