retfu / rrest Goto Github PK

See with https://github.com/apioo/psx-api maybe

See #15

This header must be optional if it is not defined or required in the spec.

If the spec is RAML, use required attribute value and/or default attribute value, see https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#default

baseUriParameters are validate like queryParameters, but need specific validation to work

For now date format follow the RAML standard: D, d M Y H:i:s T from RFC2616.

Examples:

• uniq request id
• complete version

See http://stackoverflow.com/questions/3561381/custom-http-headers-naming-conventions why no X-
for the default naming.

API proposal

<?php

$rrest->addResponseHeader('X-Request-Id', 'b228f89c-115b-3bc1-a4f6-89c1f1cbed81');

RequestId

Very useful for debugging etc...

RequestId: b228f89c-115b-3bc1-a4f6-89c1f1cbed81

API proposal

<?php

$rrest->addRequestIdHeader();

Version

Indicate the complete API version, use for debugging too.

Version: 1.2.1
Version: 2016-03-26

API proposal

<?php

$rrest->addVersionHeader('1.2.1');

The RREST\APISpec\APISpecInterface#useAuthentificationMechanism() is not enouth flexible to handle all use cases.

Add a RREST\APISpec\APISpecInterface#getAuthType() and let the app make the logic.

The controller is determine by convention:

/item/{itemId}/ -> Item
/item/{itemId}/comment -> Item\Comment

But sometime you need to choose the controller manually

API proposal

<?php
$rrest = new RREST\RREST($apiSpec, $router, 'XXX\Controllers');
$rest->addControllerAlias('/item/{itemId}/comment', YYY\ZZZ\Comment);
$rest->addControllerAlias('/item/{itemId}/ping', YYY\ZZZ\Ping);
$rest->removeControllerAlias('/item/{itemId}/ping');

See this benchmark: https://github.com/yuloh/json-schema-benchmark

In a production app, some response validation fail because the schema and the response size are huge.

Need to disable it for production I think

Actualy RREST force to define a response body format:

/XXX:
    delete:
        responses:
            204:
                body:
                    application/json:

But sometime you don't have a response at all.