octobercms/api

A RESTful API package for the OctoberCMS framework.

v1.0.4 2017-12-15 06:57 UTC

Requires

• php: ^7.0
• dingo/blueprint: ^0.2
• illuminate/routing: ^5.1
• illuminate/support: ^5.1
• league/fractal: ^0.17
• octobercms/jwt-auth: 1.0.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2
• illuminate/auth: ^5.1
• illuminate/cache: ^5.1
• illuminate/console: ^5.1
• illuminate/database: ^5.1
• illuminate/events: ^5.1
• illuminate/filesystem: ^5.1
• illuminate/log: ^5.1
• illuminate/pagination: ^5.1
• laravel/lumen-framework: ^5.1
• mockery/mockery: ~1.0
• phpunit/phpunit: ^4.8.35 || ^5.4.3 || ^6.5
• squizlabs/php_codesniffer: ~2.0

Suggests

• tymon/jwt-auth: Protect your API with JSON Web Tokens.

BSD-3-Clause

• Jason Lewis

• api
• restful
• laravel
• october
• dingo

README

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.

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 @jasonlewis so he is notified.

License

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