Outsource Laravel Development Partner - $2500/Month | Bacancy

Generate a JSON Feed with Laravel

Published on by

Generate a JSON Feed with Laravel image

JSON Feed is a new standard to formalize a JSON based RSS feed that aims to simplify creating feeds by doing away with the XML standard. Implementing a feed for your site is simple, and the spec is surprisingly clear.

Here is a simple example of it:

{
"version": "https://jsonfeed.org/version/1",
"title": "My Example Feed",
"home_page_url": "https://example.org/",
"feed_url": "https://example.org/feed.json",
"items": [
{
"id": "2",
"content_text": "This is a second item.",
"url": "https://example.org/second-item"
},
{
"id": "1",
"content_html": "<p>Hello, world!</p>",
"url": "https://example.org/initial-post"
}
]
}

I just implemented this feed format for Laravel News, and you can find the results here. As a quick example let’s go through setting up a feed like this.

Grab a list of Posts

The first step is to grab a list of records from the database. For this site the items are stored in a “Posts” table and using Eloquent I grab the latest 20 for the feed:

$posts = Post::limit(20)->get();

Setup the main JSON Feed data

The JSON Feed spec has a few optional top level fields such as title, feed URL, site icon, and more. Since these are not dynamic I added them to an array manually:

$data = [
'version' => 'https://jsonfeed.org/version/1',
'title' => 'Laravel News Feed',
'home_page_url' => 'https://laravel-news.com/',
'feed_url' => 'https://laravel-news.com/feed/json',
'icon' => 'https://laravel-news.com/apple-touch-icon.png',
'favicon' => 'https://laravel-news.com/apple-touch-icon.png',
'items' => [],
];

The empty items will hold all of our posts.

Add the JSON Feed Items

The final step is to loop through all of our $posts and add it to the items array. Here is an example using my data:

foreach ($posts as $key => $post) {
$data['items'][$key] = [
'id' => $post->id,
'title' => $post->title,
'url' => 'https://laravel-news.com/'.$post->uri,
'image' => $post->featured_image,
'content_html' => $post->parsed_content,
'date_published' => $post->created_at->tz('UTC')->toRfc3339String(),
'date_modified' => $post->updated_at->tz('UTC')->toRfc3339String(),
'author' => [
'name' => $post->user->name
],
];
}

The only part that is unique is the time stamps. I’m utilizing Carbon’s features to convert to UTC and then to the RFC 3339 format which the JSON spec requires.

Final Results

Here is the complete final method:

public function json()
{
$posts = Post::active()->limit(20)->get();
 
$data = [
'version' => 'https://jsonfeed.org/version/1',
'title' => 'Laravel News Feed',
'home_page_url' => 'https://laravel-news.com/',
'feed_url' => 'https://laravel-news.com/feed/json',
'icon' => 'https://laravel-news.com/apple-touch-icon.png',
'favicon' => 'https://laravel-news.com/apple-touch-icon.png',
'items' => [],
];
 
foreach ($posts as $key => $post) {
$data['items'][$key] = [
'id' => $post->id,
'title' => $post->title,
'url' => 'https://laravel-news.com/'.$post->uri,
'image' => $post->featured_image,
'content_html' => $post->parsed_content,
'date_created' => $post->publishes_at->tz('UTC')->toRfc3339String(),
'date_modified' => $post->updated_at->tz('UTC')->toRfc3339String(),
'author' => [
'name' => $post->user->name
],
];
}
return $data;
}

One thing to notice is that with Laravel we do not have to set any special headers or really anything. Just return the $data array, and it’ll automatically be converted to JSON and have the proper headers.

If you’d like to implement a package for this or need a more advanced setup check out the brand new LaravelJsonFeed package by Mateus Guimarães.

Eric L. Barnes photo

Eric is the creator of Laravel News and has been covering Laravel since 2012.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Enjoy coding and debugging in an editor designed for fast feedback and quick iterations. It's like a shell for your application – but with multi-line editing, code completion, and more.

Visit Tinkerwell
Curotec logo

Curotec

World class Laravel experts with GenAI dev skills. LATAM-based, embedded engineers that ship fast, communicate clearly, and elevate your product. No bloat, no BS.

Curotec
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
NativePHP logo

NativePHP

Build rich mobile apps across iOS and Android from a single Laravel codebase. This changes everything!

NativePHP
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit

The latest

View all →
Laravel Nightwatch - Deep monitoring & insights, no matter where you deploy. image

Laravel Nightwatch - Deep monitoring & insights, no matter where you deploy.

Read article
Filament v4 Beta - Feature Overview image

Filament v4 Beta - Feature Overview

Read article
AnyCable Laravel Broadcaster image

AnyCable Laravel Broadcaster

Read article
Parse Localized Numbers with Laravel's Number Class image

Parse Localized Numbers with Laravel's Number Class

Read article
Manage Taxonomies, Categories, and Tags in Laravel image

Manage Taxonomies, Categories, and Tags in Laravel

Read article
Extract Arrays from Any Data Type with Laravel's Arr::from Method image

Extract Arrays from Any Data Type with Laravel's Arr::from Method

Read article