check24/apitk-header-bundle

This bundle provides helpful api helpers for RESTful API's

Installs: 3 982

Dependents: 2

Suggesters: 0

Security: 0

Stars: 1

Watchers: 4

Forks: 4

Type:symfony-bundle

4.0.0 2022-01-19 12:58 UTC

This package is auto-updated.

Last update: 2022-09-04 21:35:26 UTC


README

Overview

This bundle provides useful features for a symfony based RESTful API.

Installation

Install the package via composer:

composer require check24/apitk-header-bundle

Usage

Header information

You can easily add information to the response headers by using the HeaderInformation service. These information will automatically be added to the response and prefixed with x-apitk-

public function index(HeaderInformation $headerInformation): array
{
    $users = $this->getUsers();

    $headerInformation->add('users-count', (string) count($users));

    return $users;
}

will result in a response header x-apitk-users-count: 15.

Deprecations (apitk-deprecation-bundle)

You can mark actions as deprecated so developers can notice that they have to update their API call to a newer version or to use a whole other endpoint.

see CHECK24/apitk-deprecation-bundle