Yii2 RESTful Webservice: JSON Request Format

Question

this is my first question:

I'm trying to build a RESTful Webservice with Yii2. The Controller extends from ActiveController and has the corresponding model. Reading of data works fine and without problems.

But when I try to create new Objects I run into an error. I use the Chrome extension Advanced Rest Client and POST the following data:

{
    "team": 1
}

I also tried different formats.

But I always get this response:

[{
    "field":"team",
    "message":"Team cannot be blank."
}]

Do you have any suggestions what I'm doing wrong?

Thanks!

Could you pls put the section where you capture the $_POST params in your action? — Gihan, Jun 24 '14 at 02:40

score 22 · Accepted Answer · answered Jun 24 '14 at 15:27

22

I think you all got me on the right track. Thanks for that!

The problem was that Yii2 uses an integrated parser for parsing JSON request. I thought these parser is konfigured by default (as there is no hint to configure it in the documentation). But the parser had to be configured by myself.

Here is how to configure the parser in the main-configuration:

'request' => [
    'parsers' => [
        'application/json' => 'yii\web\JsonParser',
    ]
]

You can find more information here: JsonParser

I hope this can help others running into the same problem.

answered Jun 24 '14 at 15:27

PhilippS

2,785
4
16
20

awesome!! this is exactly my problem! – intellion Jul 17 '14 at 16:27
1

It also helps if you explicitly add the headers 'Content-Type = application/json' when you submit the request – d.raev Jul 18 '14 at 12:38
Still I cannot get the request params 'request' => [ 'parsers' => [ 'application/json' => 'yii\web\JsonParser', ], 'cookieValidationKey' => '1VwIjoKRv9mGh6NTZnmvFu1roaeC2zdQ', ], – Yasar Arafath Sep 08 '17 at 05:34

score 3 · Answer 2 · edited May 23 '17 at 11:46

3

I think you are capturing the posted data with $_POST which doesn't work. Because you are sending json data. If so you have to use file_get_contents('php://input') to access the sending data. It's an issue with the Content-Type header of the request. The $_POST works when it is set to application/x-www-form-urlencoded

Here is a similar question handle json request in PHP

edited May 23 '17 at 11:46

Community

1
1

answered Jun 24 '14 at 02:48

Gihan

4,163
6
31
49

This worked for me for 'Content-Type: application/xml' – crafter May 20 '16 at 19:48
You can use [Request::getBodyParams](http://www.yiiframework.com/doc-2.0/yii-web-request.html#getBodyParams()-detail) to get and parse the input depending on `Content-Type` header. – ezze May 27 '16 at 12:23

Yii2 RESTful Webservice: JSON Request Format

2 Answers2