API Routes

API Routes

This section will go over everything you need to know about API routes.

/api/entries/{namespace}/{stream}

The entries endpoint exposes Stream entries specified by the namespace and stream parameters.

Parameters

/api/entries/{namespace}/{stream}/{id}

The entries endpoint also exposes single Stream entries specified by the namespace, stream, and id parameters.

Parameters

Traversing Relationships

You can use a RESTful pattern to traverse entry relationships and format the results too:

For example to get the category for the post with ID 1:

/api/entries/posts/posts/1/category

To get the user that created the above category:

/api/entries/posts/posts/1/category/created_by

Defining API Routes

Defining custom API routes could not be easier. Let's take a look at a couple ways to handle this.

Addon Service Providers

You can define your API routes just like normal routes in the protected $api = [] property of your addon service provider:

protected $api = [
    'api/example-module/test' => 'Anomaly\ExampleModule\Http\Controller\Api\TestController@doSomething'
];

Laravel Router

You can also define routes the Laravel way using the Router. Just make sure to define the auth:api middleware:

Router::get('api/example-module/test', 'Anomaly\ExampleModule\Http\Controller\Api\TestController@doSomething')
    ->middleware('auth:api');

The Resource Controller

Your API controllers should extend the base resource controller:

<?php namespace Anomaly\ExampleModule\Http\Controller\Api;

use Anomaly\Streams\Platform\Http\Controller\ResourceController;

class TestController extends ResourceController
{

}