Getting started with ASP.NET Core 7 Minimal APIs
Imagine you are a new chef, eager to make your mark in the culinary world. You have a passion for cooking, but you're just starting and don't have much experience yet. You want to create a new recipe that showcases your skills, but you're not quite sure where to start.
This is where Minimal APIs come in. Minimal APIs provide a simplified way to create web APIs that are lightweight and easy to use. In the same way that a new chef might start with a simple recipe that has few ingredients and minimal steps, Minimal APIs allow developers to create APIs with minimal code and configuration.
To get started with Minimal APIs, you don't need to be an experienced developer or have a lot of technical knowledge. With just a few lines of code, you can create an endpoint that responds to HTTP requests, whether it's a simple "Hello World" message or a more complex API that interacts with a database.
Minimal APIs are also flexible, so you can customize them to suit your specific needs. Whether building a small application for personal use or a large-scale enterprise system, Minimal APIs can provide the foundation you need to create a powerful and effective API.
So, whether you're a new or experienced developer who wants to get started with Minimal APIs, all you need is a basic understanding of programming concepts and a willingness to learn. With Minimal APIs, you can start small and build your way up to more complex applications, all while enjoying the simplicity and flexibility that this technology provides.
With that in mind, here are some of the requirements to get started:
IDE or Code Editor. In our case, we will use the famous visual studio code which is free and can be found here.
The .NET 7 SDK can be found here.
We will use C# as the programming language, so I will assume you have some knowledge. However, if you're not familiar with C#, don't worry, you can still benefit from this guide.
If you are all set, you should be able to do
dotnet --version in your VS Code terminal and get the version of the dotnet SDK installed as such:
Now, let's create our first API using the Minimal API architecture. All you need to do is to open your terminal and follow the steps below:
Step 1: Create a new project In your terminal, navigate to the directory where you want to create your project. Then, run the following command to create a new minimal API project:
dotnet new web -n CookingAPI
The command above creates an empty ASP.NET Core Minimal API called CookingAPI with a single endpoint that returns a Hello World from the route path endpoint.
Step 2: Open the project in your favorite code editor, such as Visual Studio Code or Rider in my case, and navigate to the
Program.cs file. In this file, we'll define the routes and actions for our API.
Let's say you want to create an endpoint that returns a list of recipes. Add the following code inside the
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
app.MapGet("/recipes", () =>
// list of recipes
var recipes = new List<string>
"Bugali na Sombe",
"Sambaza an chips"
Above, we have used the MapGet method to define a route for the
/recipes endpoint. Inside the endpoint action, you can add the logic to fetch the list of recipes from a data source. For simplicity, we have hardcoded a list of recipes as an example. In the next blog post, we will connect a data source and get the data from a database such as Sqlite or Postgres.
Step 3: Run the API
Save the changes and go back to your terminal in your VS Code. Navigate to the root directory of your project and run the following command:
dotnet run will build and run the API. Once it's up and running, let's open Postman or any favorite tool for testing your API. You should have something like this if you are using Postman:
In Postman, navigate to http://localhost:5185/recipes using the GET method. On a side note, the port number of the URL might be different from mine. Mind and change according to your environment. Send the request, and you should receive a response containing a list of recipes as follows:
"Bugali na Sombe",
"Sambaza an chips"
Congratulations! You have successfully created your first API using the Minimal API architecture. From here, you can expand and enhance your API by adding more routes, and actions, and integrating it with a database or other external services.
Remember, just like in cooking, practice makes perfect. Experiment with different endpoints, data sources, and functionalities to sharpen your API development skills. In our next blog post, we'll see how we can connect to a data source.
Keep cooking up some amazing APIs with ASP.NET Core 7 Minimal APIs! Remember, just like in cooking, practice makes perfect. To cook some amazing APIs, you can start with this introduction and then move to some of the most advanced concepts.
The source code for this introduction can be found here.