Dingo API

Dingo API provides a set of tools for building APIs in Laravel, including:

• Content Negotiation: Handling different media types.
• Multiple Authentication Adapters: Support for various auth methods.
• API Versioning: Managing different versions of your API.
• Rate Limiting: Controlling request frequency.
• Response Transformers and Formatters: Shaping API output.
• Error and Exception Handling: Standardized error responses.
• Internal Requests: Making requests to your own API internally.
• API Blueprint Documentation: Generating documentation from blueprints.

Dingo API uses a configuration file located at config/api.php. To prevent a RuntimeException during boot, you must ensure that either a prefix or a domain is configured if the application is not running in the console.

Key configuration options used by the service provider include:

• prefix: The URL prefix for your API.
• domain: The domain used for your API.
• version: The default API version.
• subtype: The API subtype.
• standardsTree: The standards tree (e.g., vnd).
• defaultFormat: The default response format.
• errorFormat: The format used for error responses.
• debug: Boolean to enable/disable debug mode.
• auth: Authentication configuration.
• transformer: Transformer configuration.
• formats: Response formatters.
• formatsOptions: Options for response formats.

The LumenServiceProvider registers several built-in route middleware that you can apply to your routes. Use the following keys in your route definitions:

• api.auth: Handles authentication via Dingo\Api\Http\Middleware\Auth.
• api.throttle: Handles rate limiting via Dingo\Api\Http\Middleware\RateLimit.
• api.controllers: Prepares controllers via Dingo\Api\Http\Middleware\PrepareController.

The api:routes command supports several options to filter the route list or change the display format:

Filtering Options

• --path=<string>: Filter routes by their URI path.
• --name=<string>: Filter routes by their name.
• --versions=<version>: Filter routes by specific version(s). This option accepts multiple values.
• --scopes=<scope>: Filter routes by specific scope(s). Use the -S flag. This option accepts multiple values.
• --protected: Show only protected routes.
• --unprotected: Show only unprotected routes.

Display and Sorting Options

• --sort=<column>: Sort the output by a specific column. Valid columns are: domain, method, uri, name, action.
• --reverse: Reverse the order of the sorted routes.
• --short: Display an abridged version of the routes containing only Method, URI, Name, and Version(s).

Dingo API registers several class aliases in the Laravel service container to allow for easy access to its core components. You can resolve these using the following keys:

The api:docs command supports the following options to customize the documentation generation process:

api:docs {--name= : Name of the generated documentation}
{--use-version= : Version of the documentation to be generated}
{--output-file= : Output the generated documentation to a file}
{--include-path= : Path where included documentation files are located}
{--use-controller= : Specify a controller where to generate documentation for}