Get the MDX template

use Fetchski\AttractCmsLaravel\Facades\Attract;

$path = Attract::blogPosts()->getBlogMdxTemplate()->saveTo(storage_path('app/blog/')); // …/storage/app/blog/template_blog_post.mdx

{
  "filename": "template_blog_post.mdx",
  "content": "---\ntitle: …\n---\n"
}

In your app

A controller answers a route on your app: it calls getBlogMdxTemplate() and answers the file as a download (download()).

Add the controller

app/Http/Controllers/GetBlogMdxTemplateController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Http\Response;

final class GetBlogMdxTemplateController
{
    public function __invoke(): Response
    {
        return Attract::blogPosts()->getBlogMdxTemplate()->download();
    }
}

Add the route

routes/web.php

use App\Http\Controllers\GetBlogMdxTemplateController;
use Illuminate\Support\Facades\Route;

Route::get('/blog/mdx-template', GetBlogMdxTemplateController::class);

Register it before Route::get('/blog/{id}', …): Laravel takes the first route that matches, and that one matches this URL too.

Call it

Terminal

curl -OJ http://localhost:8000/blog/mdx-template

With php artisan serve running, it saves template_blog_post.mdx in the folder you run it from (-O saves the answer, -J under the name the download gives).

To keep the call in an Action instead, this writes app/Actions/Attract/GetBlogMdxTemplate.php (an invokable Action that calls getBlogMdxTemplate()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action blogPosts.getBlogMdxTemplate

Call it from the terminal

Terminal

php artisan attract:call blogPosts.getBlogMdxTemplate --save=storage/app/blog/

It calls getBlogMdxTemplate() on your default site and saves the file in storage/app/blog/ as template_blog_post.mdx (leave out --save to print it as JSON). See Call any method from the terminal for every argument type.

Parameters

None: call it with no arguments.

Returns

A BlogTemplate (Fetchski\AttractCmsLaravel\Data\BlogTemplate). The template. Read its properties ($blogTemplate->filename): each says whether the site always sends it. Save it with saveTo($path) (a folder keeps the site’s file name, template_blog_post.mdx), or answer a browser with download().

string

Always sent. The file name to save the template under.

string

Always sent. The template: front matter naming every field, then guidance for the body.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

401

The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage(), errorName(), data().

403

The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read: siteMessage(), errorName(), data().

429

The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter() (seconds, or null), siteMessage().

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason(), neverConnected().

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

Access: an API key with content:blog:write, or content:blog:all, or content:all, or admin:all, or a signed-in user holding the blog:import-markdown permission. Other callers get 403.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/GetBlogMdxTemplateTest.php, then run your tests:

tests/Feature/GetBlogMdxTemplateTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetBlogMdxTemplateTest extends TestCase
{
    public function test_get_blog_mdx_template(): void
    {
        Attract::fake();

        $this->getJson('/blog/mdx-template')->assertDownload('template_blog_post.md');

        Attract::assertCalled('blogPosts.getBlogMdxTemplate');
    }
}

Terminal

php artisan test

Answer with your own values: fake blogPosts.getBlogMdxTemplate with BlogTemplate::factory()->make([...]), the fields you give over a valid example.

tests/Feature/GetBlogMdxTemplateAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\BlogTemplate;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetBlogMdxTemplateAnswerTest extends TestCase
{
    public function test_get_blog_mdx_template_answers_your_values(): void
    {
        Attract::fake([
            'blogPosts.getBlogMdxTemplate' => BlogTemplate::factory()->make(['filename' => 'Your value']),
        ]);

        $blogTemplate = Attract::blogPosts()->getBlogMdxTemplate();

        $this->assertSame('Your value', $blogTemplate->filename);
    }
}

List a blog post’s locales

Attract::blogPosts()->getBlogLocales()

Get the Markdown template

Attract::blogPosts()->getBlogMarkdownTemplate()

List blog posts

Attract::blogPosts()->listBlogs()

Create a blog post

Attract::blogPosts()->createBlog()

Get a blog post

Attract::blogPosts()->getBlog()

Replace a blog post

Attract::blogPosts()->replaceBlog()

GET /@apostrophecms/blog/mdx-template

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

Test it

List a blog post’s locales

Get the Markdown template

List blog posts

Create a blog post

Get a blog post

Replace a blog post

GET /@apostrophecms/blog/mdx-template

In your app

Call it from the terminal

Behavior

Test it

Related

List a blog post’s locales

Get the Markdown template

List blog posts

Create a blog post

Get a blog post

Replace a blog post

GET /@apostrophecms/blog/mdx-template