Unveiling Umbraco CMS: A Developer’s Guide to Content Delivery API (Part 1)

Dhanesh Kumar MJ
4 min readOct 28, 2023

--

Welcome to the thrilling world of Umbraco 12! In this exciting series, e can learn about the Content Delivery API. This is Part 1 of the adventure, where I'll guide you through setting up Umbraco 12 on your local machine and give you a sneak peek at the magic of the Content Delivery API.

Let’s start the Umbraco 12 headless journey!

But, before you join the Umbraco journey, you need to make sure you’ve got the right attire:

Make sure you’ve got .NET 7.0 or newer.

Check the installed version using below command:

dotnet --version

With that sorted, your are now ready to set up Umbraco 12 on your local playground. Here’s how to get the party started:

Step 1: Open up your command line in the folder where you want your Umbraco solution to reside. Install the latest Umbraco Templates using the below commands:

dotnet new install Umbraco.Templates

Step 2: Let’s create the Umbraco solution with this command:

dotnet new sln --name "Umbraco12HeadLessDemo"
dotnet new umbraco --force -n "Umbraco12HeadLessDemo" --friendly-name "Administrator" --email "{{your email}}" --password "{{your password}}" --development-database-type SQLite
dotnet sln add "Umbraco12HeadLessDemo"

The above command will create a Umbraco 12 project, using SQLite as the database, and it will also create a user as an Administrator with the username being the provided email and the specified password.

Step 3: Enter the project folder. It will be the folder containing the .csproj file & Run the project using dotnet run

The above command will build & run the project.

Step 4: Open the URL, and navigate to the back office at /umbraco ,Login with given username & password.

Here we can see the blank Umbraco CMS Backoffice.

Step 5: We need to install a starter kit for saving some time using the below command:

dotnet add package Umbraco.TheStarterKit - version 12.0.0

Step 6: Once installed again run the project using the command dotnet run , go to Backoffice and we can see the contents gets created from the starter kit.

Where’s the Magic Sauce?

It’s time to conjure up some magic. Navigate your way to “/umbraco/swagger/index.html,” and prepare to be dazzled by Swagger UI. There, you’ll discover the “Content Delivery API” patiently waiting for your exploration.

Umbraco 12 Headless Sample project here — https://github.com/dKumarmj/Umbraco12HeadlessDemo

Join friendly community to know more about Umbraco — https://www.meetup.com/kerala-umbraco-community/events/

Part 2 : https://medium.com/@dev.mjdhanesh/unveiling-umbraco-12-a-developers-guide-to-content-delivery-api-part-2-ed0637a42513

Conclusion

In this Part 1 of our Umbraco 12 journey, we’ve set the stage for an exciting adventure with the Content Delivery API. We’ve taken our first steps into the world of Umbraco 12.

We’ve successfully set up Umbraco 12 on our local machine, ensuring we’re equipped with the right tools and environment to explore what this CMS has to offer. We’ve even had a sneak peek at the Content Delivery API, thanks to Swagger UI, and the possibilities are already looking intriguing.

In the upcoming parts of this series, we’ll dig deeper into the Content Delivery API, exploring its features and how you can leverage them for your projects.

--

--

Dhanesh Kumar MJ

Engineer @ Phases.io| Traveler | Story Teller | Spiritual Being