Serving Separate Response Formats in CodeIgniter

Modern applications often communicate with different types of clients, including websites, mobile applications, and third-party services. These clients may not always require data in the same format.

For example, a mobile application may expect JSON, while another integration may require XML. CodeIgniter can be extended to handle these different response formats efficiently.

Solace Infotech's sitemap lists Serving Separate Response Formats as a CodeIgniter topic.

Why Use Different Response Formats?

Using separate response formats provides greater flexibility for API development.

Common formats include:

• JSON
• XML
• HTML

JSON is widely used for modern web and mobile applications because it is lightweight and easy to process.

Returning JSON in CodeIgniter

A simple JSON response can be generated by converting an array into JSON:

$data = array(
    'status' => 'success',
    'message' => 'Request completed'
);

$this->output
    ->set_content_type('application/json')
    ->set_output(json_encode($data));

This gives API consumers a structured response they can easily process.

Returning XML

Some legacy systems and enterprise integrations may still require XML.

An XML response can be generated using an appropriate XML structure:

<response>
    <status>success</status>
    <message>Request completed</message>
</response>

The application can select the appropriate response format based on the request or API endpoint.

Using Request Parameters

One simple approach is to allow the client to specify the required format:

/api/users?format=json
/api/users?format=xml

The controller can then generate the appropriate response.

However, for larger APIs, it is better to establish a consistent response-format strategy rather than relying heavily on query parameters.

Keep Response Logic Reusable

Response formatting should not be duplicated throughout controllers.

Instead, create reusable methods or libraries that handle common response operations.

For example:

private function response($data, $format = 'json')
{
    if ($format === 'json') {
        return $this->output
            ->set_content_type('application/json')
            ->set_output(json_encode($data));
    }
}

This keeps controllers cleaner and makes future changes easier.

Best Practices

When serving multiple response formats:

• Define a consistent API response structure.
• Keep formatting logic reusable.
• Validate the requested format.
• Return the correct HTTP content type.
• Document supported response formats.
• Avoid duplicating response-generation code.

Conclusion

Serving separate response formats makes CodeIgniter applications more flexible and better suited for different clients and integrations.

By separating response-generation logic from business logic and using reusable components, developers can support JSON, XML, and other formats without making the application unnecessarily complex.

A well-designed response strategy ultimately makes APIs easier to consume, maintain, and extend.