api-ecosystem-for-laravel/dingo-api

A RESTful API package for the Laravel and Lumen frameworks.

v4.3.0 2024-08-21 11:40 UTC

Requires

• php: ^8.0
• illuminate/routing: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0
• league/fractal: ^0.20

Requires (Dev)

• dingo/blueprint: ~0.4
• friendsofphp/php-cs-fixer: ~3
• illuminate/auth: ^9.0|^10.0|^11.0
• illuminate/cache: ^9.0|^10.0|^11.0
• illuminate/console: ^9.0|^10.0|^11.0
• illuminate/database: ^9.0|^10.0|^11.0
• illuminate/events: ^9.0|^10.0|^11.0
• illuminate/filesystem: ^9.0|^10.0|^11.0
• illuminate/log: ^9.0|^10.0|^11.0
• illuminate/pagination: ^9.0|^10.0|^11.0
• laravel/lumen-framework: ^9.0|^10.0|^11.0
• mockery/mockery: ~1.0
• php-open-source-saver/jwt-auth: ^1.4 | ^2.2
• phpunit/phpunit: ^9.0|^10.0
• squizlabs/php_codesniffer: ~2.0

Suggests

• dingo/blueprint: Legacy package which can produce API docs from dingo/api
• php-open-source-saver/jwt-auth: Protect your API with JSON Web Tokens.
• specialtactics/laravel-api-boilerplate: API Boilerplate for Laravel

BSD-3-Clause

• Jason Lewis

• api
• restful
• laravel
• dingo

README

Note: This is an official and reasonably maintained fork of the popular https://github.com/dingo/api repository by one of the maintainers of that project. The reason it was forked is due to broken integrations with CI tools such as travis (which can only be fixed by owner), and in general to be able to better support the project and ensure non-breaking updates.

In order to move to this repo, you merely need to update your composer file. All the namespaces and other aspects of the project are the same. Example instructions are below, to use the latest version:

composer remove dingo/api
composer require api-ecosystem-for-laravel/dingo-api

Please note, we do not actively maintain the Lumen support of this project. If you are still using Lumen, we recommend you migrate to Laravel.

The Dingo API package is meant to provide you, the developer, with a set of tools to help you easily and quickly build your own API. While the goal of this package is to remain as flexible as possible it still won't cover all situations and solve all problems.

Features

This package provides tools for the following, and more:

• Content Negotiation
• Multiple Authentication Adapters
• API Versioning
• Rate Limiting
• Response Transformers and Formatters
• Error and Exception Handling
• Internal Requests
• API Blueprint Documentation

Documentation

Please refer to our extensive Wiki documentation for more information.

API Boilerplate

If you are looking to start a new project from scratch, consider using the Laravel API Boilerplate, which builds on top of the dingo-api package, and adds a lot of great features for API development.

Support

For answers you may not find in the Wiki, avoid posting issues. Feel free to ask for support on the dedicated Slack room. Make sure to mention specialtactics so he is notified.

Alternatively, you can start a new discussion in the Q&A category.

License

This package is licensed under the BSD 3-Clause license.