PHP download

Download the PHP package dskripchenko/laravel-api without Composer

On this page you can find all versions of the php package dskripchenko/laravel-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download dskripchenko/laravel-api
More information about dskripchenko/laravel-api
Files in dskripchenko/laravel-api

Vendor dskripchenko
Package laravel-api
Short Description The Laravel Api Module.
License MIT
Homepage https://github.com/dskripchenko/laravel-api

Keywords api versioning laravel swagger

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of dskripchenko/laravel-api

Informations about the package laravel-api

Installation

Run

or add

to the section of your composer.json file.

Usage

See

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\Providers\ApiServiceProvider
override getApiModule in new ApiServiceProvider
register ApiServiceProvider

Api methods template

AutoDoc comments to swagger

Available types

Components

BaseApi
- getMethods
- getSwaggerTemplates
- beforeCallAction
- afterCallAction
- getDefaultEmptyResponse
- getMiddleware
- registerApiComponent
BaseModule
- makeApi
- getApiMiddleware
- getApiPrefix
- getAvailableApiMethods
- getApiUriPattern
- getApiVersionList
Meta
- action
  - create
  - read
  - update
  - delete
  - crud
- column
  - string
  - boolean
  - number
  - integer
  - hidden
  - select
  - file
- getSwaggerInputs
- toArray

Console

Commands

ApiInstall
- getEnvConfig
- fillEnvironment
- reloadEnvironment
- onBeginSetup
- onEndSetup
BaseCommand
- askValid
- validateInput

Controllers

ApiController
- success
- error
- validationError
ApiDocumentationController
- index
CrudController
- meta
- search
- create
- read
- update
- delete
- getSwaggerMetaInputs

Exceptions

ApiErrorHandler
- addErrorHandler
- handle
ApiException
- getErrorKey
Handler
- render

Facades

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

Middlewares

ApiMiddleware
- run

Providers

ApiServiceProvider
- getApiModule
- getApiErrorHandler
- getApiRequest
- makeApiRoutes
BaseServiceProvider
- mergeConfigFrom

Requests

BaseApiRequest
- validateApiUriPattern
- prepareApi
CrudSearchRequest

Resources

BaseJsonResource
BaseJsonResourceCollection

Services

ApiResponseHelper
- say
- sayError
CrudService
- meta
- query
- resource
- collection
- search
- create
- read
- update
- delete

Traits

SwaggerApiTrait
- getSwaggerApiConfig

Interfaces

CrudServiceInterface
- meta
- query
- resource
- collection
- search
- create
- read
- update
- delete

Example

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

All versions of laravel-api with dependencies

PHP Build Version

Package Version

Version 2.5.2 Release 09. Jul 2024
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of laravel-api from vendor dskripchenko

Requires ext-json Version *
dskripchenko/php-array-helper Version ^1.0
laravel/framework Version 6.*|7.*|8.*|9.*|10.*|11.*
phpdocumentor/reflection-docblock Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dskripchenko/laravel-api contains the following files

Loading the files please wait ....