PHPackages                             denysloshkarev/laravel-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. denysloshkarev/laravel-api

ActiveLibrary[API Development](/categories/api)

denysloshkarev/laravel-api
==========================

The Laravel Api Module.

1.3.10(6y ago)012MITCSS

Since Mar 29Pushed 6y agoCompare

[ Source](https://github.com/denisloshkarev/laravel-api)[ Packagist](https://packagist.org/packages/denysloshkarev/laravel-api)[ Docs](https://github.com/dskripchenko/laravel-api)[ RSS](/packages/denysloshkarev-laravel-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (2)Versions (5)Used By (0)

Installation
------------

[](#installation)

```
$ php composer.phar require dskripchenko/laravel-api "@dev"

```

or add

```
"dskripchenko/laravel-api": "@dev"

```

to the `require` section of your `composer.json` file.

Usage
-----

[](#usage)

See `Dskripchenko\LaravelApiExample\`

- make `ApiModule` extended from `Dskripchenko\LaravelApi\Components\BaseModule`
- make `Api` extended from `Dskripchenko\LaravelApi\Components\BaseApi`
- define `getMethods` method
- override `getApiVersionList` in `ApiModule`, return array of `['version' => Api::class]`
- make `ApiServiceProvider` extended from `Dskripchenko\LaravelApi\ApiServiceProvider`
- override `getApiModule` in new `ApiServiceProvider`
- register `ApiServiceProvider`

Api methods template
--------------------

[](#api-methods-template)

```
protected static function getMethods(){
    return [
      'controllers' => [
        '{controllesKey1}' => [
            'controller' => '{Controller::class}',
            'actions' => [
                '{actionKey1}', // api/version/{controllesKey1}/{actionKey1}
                '{actionKey2}' => '{real method name}', //api/version/{controllesKey1}/{actionKey2}
                '{actionKey3}' => false, //disable //api/version/{controllesKey1}/{actionKey3}
                '{actionKey4}' => [
                    'exclude-all-middleware' => true, //optional, exclude all global and controller middleware
                    'middleware' => [
                        "{Middleware::class}"
                    ], //optional, define specific middleware
                    'exclude-middleware' => [], //optional, exclude specific middleware
                ],
            ],
            'exclude-all-middleware' => true, //optional, ...
            'middleware' => [], //optional, ...
            'exclude-middleware' => [], //optional, ...
        ]
      ],
      'middleware' => [] //optional, ...
    ];
}
```

AutoDoc comments to swagger
---------------------------

[](#autodoc-comments-to-swagger)

```
/**
 * Method title
 * Method description
 *
 * @input type $requiredVariable1 name1
 * @input type ?$optionalVariable2 name2
 *
 * @output type $variable1 name1
 * @output type $variable2 name2
 */
```

Available types `string|number|integer|boolean|file`

Facades
-------

[](#facades)

- ApiRequest
    - getApiVersion
    - getApiMethod
    - getApiControllerKey
    - getApiActionKey
- ApiModule
    - getApiPrefix
    - getAvailableApiMethods
    - getApiUriPattern
    - getControllerNamespace
    - getApiMiddleware
    - getApiVersionList
    - makeApi
- ApiErrorHandler
    - addErrorHandler
    - handle

Helpers
-------

[](#helpers)

- ApiResponseHelper
    - say
    - sayError
- ArrayMergeHelper
    - merge //deep array merge

Example
-------

[](#example)

- register `Dskripchenko\LaravelApiExample\ExampleApiServiceProvider`
- run `php artisan vendor:publish`
- run `php artisan storage:link`
- open `/api/doc`

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 93.5% of commits — single point of failure

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 ~13 days

Total

3

Last Release

2202d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b8d87cd331eefd8d230c725e7c1b258c5e2540514351089069417e8d94527a39?d=identicon)[denisloshkarev](/maintainers/denisloshkarev)

---

Top Contributors

[![dskripchenko](https://avatars.githubusercontent.com/u/5102028?v=4)](https://github.com/dskripchenko "dskripchenko (29 commits)")[![denysloshkarev](https://avatars.githubusercontent.com/u/26629861?v=4)](https://github.com/denysloshkarev "denysloshkarev (2 commits)")

---

Tags

apilaravelswaggerversioning

### Embed Badge

![Health badge](/badges/denysloshkarev-laravel-api/health.svg)

```
[![Health](https://phpackages.com/badges/denysloshkarev-laravel-api/health.svg)](https://phpackages.com/packages/denysloshkarev-laravel-api)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[despark/apidoc

Generate api documentation and use swagger to consume it

132.3k](/packages/despark-apidoc)

PHPackages © 2026

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