API Response Trait about codeigniter4 HOT 5 CLOSED

Are you referring to a simplified version of Laravel's Resource Controllers? https://laravel.com/docs/5.3/controllers#resource-controllers

from codeigniter4.

Nope. CI already has Resourceful Routes. In this, I'm talking about common response methods for a number of the most frequently used responses in API's. This would set the correct HTTP status code, default message, etc and send the response, thus helping a user keep a consistent, and accurate response when doing RESTful API's.

I've got one of these partially finished that I've used in a few other projects that I need to revisit, expand, and re-research to ensure they're still meeting best practices.

from codeigniter4.

You mean something like this?

// Structure.
{
  success: bool,
  status_code: int,
  data: array,
  message: string
}
// Sample success.
{
  success: true,
  status_code: 200,
  data: [{id: 1, full_name: 'a'}, {id: 2, full_name: 'b'}],
  message: 'Students list.'
}
// Sample failed.
{
  success: false,
  status_code: 404,
  data: [],
  message: 'Record not found.'
}
// Some method.
public function Api::response(int $statusCode, array $data, string $message);

from codeigniter4.

No, what I had used previously were a series of methods that made it easier to remember, like failValidation(), failUnauthorized(), etc. That way you didn't have to remember which status codes were for each state.

There's enough discussion about certain status' that it would be wise to make those customizable.

Another wrinkle is that we need to determine exactly how we're going to handle response formatting, if we do it at all. And there has been discussion internally about the possibility of formatting responses as XML, JSON, JSONP, etc, from model results, but no firm decision made just yet.

from codeigniter4.

I see. Wouldn't it be best to use constants or static variables for the codes? But in any case, I'm excited for the final decision.

from codeigniter4.