From ba6a6b3ef6324d94d3502f636e320720fc14dffe Mon Sep 17 00:00:00 2001 From: Davidson Alencar Date: Thu, 18 Jun 2015 08:41:51 -0300 Subject: [PATCH] docs/guide-pt-BR/rest-response-formatting.md - translate [ci skip] --- docs/guide-pt-BR/rest-response-formatting.md | 141 +++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 docs/guide-pt-BR/rest-response-formatting.md diff --git a/docs/guide-pt-BR/rest-response-formatting.md b/docs/guide-pt-BR/rest-response-formatting.md new file mode 100644 index 0000000..88b8b18 --- /dev/null +++ b/docs/guide-pt-BR/rest-response-formatting.md @@ -0,0 +1,141 @@ +Formatação de Resposta +=================== + +Ao manipular um request API RESTful, um aplicação normalmente realiza as seguintes etapas que estão relacionadas com a formatação da resposta: + +1. Determinar diversos fatores que podem afetar o formato da resposta, tais como tipo de mídia, linguagem, versão, etc. Este processo também é conhecido como [content negotiation](http://en.wikipedia.org/wiki/Content_negotiation). +2. Converter objetos de recurso em arrays, como descrito na seção [Resources](rest-resources.md). Isto é feito por [[yii\rest\Serializer]]. +3. Converte arrays em uma string no formato como determinado pela etapa de negociação de conteúdo. Isto é feito por [[yii\web\ResponseFormatterInterface|response formatters]] registrado com a propriedade [[yii\web\Response::formatters|formatters]] do `response` [application component](structure-application-components.md). + + +## Negociação de conteúdo + +Yii suporta negociação de conteúdo através do filtro [[yii\filters\ContentNegotiator]]. A classe base de controller API RESTful [[yii\rest\Controller]] está equipado com este filtro sob o nome de `contentNegotiator`. O filtro fornece negociação de formato de resposta, bem como negociação de idioma. Por exemplo, se um request API RESTful tiver o seguinte cabeçalho, + +``` +Accept: application/json; q=1.0, */*; q=0.1 +``` + +ele irá obter uma resposta em formato JSON, como o seguinte: + +``` +$ curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "http://localhost/users" + +HTTP/1.1 200 OK +Date: Sun, 02 Mar 2014 05:31:43 GMT +Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y +X-Powered-By: PHP/5.4.20 +X-Pagination-Total-Count: 1000 +X-Pagination-Page-Count: 50 +X-Pagination-Current-Page: 1 +X-Pagination-Per-Page: 20 +Link: ; rel=self, + ; rel=next, + ; rel=last +Transfer-Encoding: chunked +Content-Type: application/json; charset=UTF-8 + +[ + { + "id": 1, + ... + }, + { + "id": 2, + ... + }, + ... +] +``` + +Por baixo dos panos, antes de uma ação do controlador API RESTful ser executada, o filtro [[yii\filters\ContentNegotiator]] verificará o `Accept` do cabeçalho HTTP na requisição e definirá o [[yii\web\Response::format|response format]] para `'json'`. Após a ação ser executada e retornar o objeto resultante de recursos ou coleção, [[yii\rest\Serializer]] irá converter o resultado em um array. E finalmente, [[yii\web\JsonResponseFormatter]] irá serializar o array em uma string JSON e incluí-lo no corpo da resposta. + +Por padrão, APIs RESTful suportam tanto os formatos JSON e XML. Para suportar um novo formato, você deve configurar a propriedade [[yii\filters\ContentNegotiator::formats|formats]] do filtro `contentNegotiator` como o exemplo abaixo em suas classes do controlador da API: + +```php +use yii\web\Response; + +public function behaviors() +{ + $behaviors = parent::behaviors(); + $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_HTML; + return $behaviors; +} +``` + + +As chaves da propriedade `formats` são os tipos MIME suportados + +The keys of the `formats` property are the supported MIME types, enquanto os valores são os nomes de formato de resposta correspondentes que devem ser suportados em + [[yii\web\Response::formatters]]. + + +## Serializando Dados + +Como foi descrito acima, [[yii\rest\Serializer]] é a peça central responsável pela conversão de objetos de recurso ou coleções em arrays. Ele reconhece objetos que imolementam a interface [[yii\base\ArrayableInterface]] bem como [[yii\data\DataProviderInterface]]. O primeiro é aplicado principalmente pelos objetos de recurso, enquanto o último se aplica mais a coleções de recursos. + +Você pode configurar o serializador, definindo a propriedade [[yii\rest\Controller::serializer]] com um array de configuração. +Por exemplo, às vezes você pode querer ajudar a simplificar o trabalho de desenvolvimento do cliente, incluindo informações de paginação diretamente no corpo da resposta. Para fazê-lo, configure a propriedade [[yii\rest\Serializer::collectionEnvelope]] como abaixo: + +```php +use yii\rest\ActiveController; + +class UserController extends ActiveController +{ + public $modelClass = 'app\models\User'; + public $serializer = [ + 'class' => 'yii\rest\Serializer', + 'collectionEnvelope' => 'items', + ]; +} +``` + +Você pode, então, obter a seguinte resposta para a url `http://localhost/users`: + +``` +HTTP/1.1 200 OK +Date: Sun, 02 Mar 2014 05:31:43 GMT +Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y +X-Powered-By: PHP/5.4.20 +X-Pagination-Total-Count: 1000 +X-Pagination-Page-Count: 50 +X-Pagination-Current-Page: 1 +X-Pagination-Per-Page: 20 +Link: ; rel=self, + ; rel=next, + ; rel=last +Transfer-Encoding: chunked +Content-Type: application/json; charset=UTF-8 + +{ + "items": [ + { + "id": 1, + ... + }, + { + "id": 2, + ... + }, + ... + ], + "_links": { + "self": { + "href": "http://localhost/users?page=1" + }, + "next": { + "href": "http://localhost/users?page=2" + }, + "last": { + "href": "http://localhost/users?page=50" + } + }, + "_meta": { + "totalCount": 1000, + "pageCount": 50, + "currentPage": 1, + "perPage": 20 + } +} +``` +