Creating Responses

How to send a response from your endpoint

Your Api can return almost anything. The nnrestapi extension will take care of converting your return value to a JSON, no matter if you pass a simple array, a Domain Model or an ObjectStorage.

If no other response header or status code is specified, the nnrestapi will create all headers for a 200 OK HTTP Response. It will also automatically send the correct CORS and Credential-headers like Access-Control-Allow-Credentials etc.

Check this section to see all default headers generated and find out how to remove or add custom headers to the response.

Let’s dive into details:

• Simple Responses
  • Returning an Array
  • Returning a Domain Model
  • Returning an ObjectStorage
  • Example: Get list of all countries
  • Example: Return TypoScript-Setup
  • Example: Returning MANY rows of data
• Error Responses
  • Responding with an Error
  • Responding by throwing an Error
  • Overview of error codes
• Headers and CORS
  • Settings HTTP headers of your TYPO3 RestApi response
  • Changing a default header value
  • Adding additional headers to your response
  • Removing a header to your response
  • Overview of default headers sent: