Restricting access by sending a 403 response

How to respond with a 403 - Forbidden from inside your method

If for some reason using the @Api\Access(…) annotation or implementing a custom checkAccess(…)-method are not sufficient, you can always use return $this->response->unauthorized() to abort the further processing inside your endpoint and send a HTTP 403 Forbidden response to the frontend.

Here is an example:

namespace My\Extension\Api;

use Nng\Nnrestapi\Annotations as Api;
use Nng\Nnrestapi\Api\AbstractApi;

 * @Api\Endpoint()
class Test extends AbstractApi {

    * @Api\Access("public")
    * @return array
   public function getExampleAction()
      // Only allow access on Fridays
      if (date('w') != 4) {
         return $this->response->unauthorized("Not today, my dear. I've got a headache.");
      return ['result'=>'welcome!'];