Complete ASP NET Core Web API Tutorial Step by Step Guide

Diving into the realm of modern web development, ASP.NET Core Web API emerges as a robust and efficient framework for building robust web APIs. This guide walks you through the process of creating a simple yet powerful Web API using ASP.NET Core, the cross-platform, high-performance version of ASP.NET.

Before we embark on this tutorial, ensure you have.NET SDK 5.0 or later installed on your development machine. Additionally, familiarity with C# and understanding of Web API concepts will be beneficial for a seamless learning experience.

Setting Up the Development Environment

Our journey begins with setting up the ASP.NET Core development environment.

1. Install the .NET SDK if you haven't already by downloading and running the installer from the official Microsoft .NET website.

Creating a New Web API Project

2. Open your terminal or command prompt, navigate to your desired project location, and run the following command to create a new Web API project:

dotnet new webapi -n MyWebApiProject

This command creates a new Web API project named "MyWebApiProject" in the current directory.

Exploring the Project Structure

3. Navigate into the newly created project folder:

cd MyWebApiProject

4. Inspect the solution structure by listing its contents. You'll notice the following files and folders:

• obj
• Properties
• WeatherForecast.cs
• Program.cs
• Startup.cs
• MyWebApiProject.csproj

The .csproj file is the project file that contains metadata about the project, including its dependencies and build settings. Program.cs is the entry point of your application, while Startup.cs initializes the application's configuration and services.

Developing the Web API

Now that our project is set up, let's create an API that returns a list of employees.

1. Open the MyWebApiProject.csproj file and add the following NuGet package reference for Entity Framework Core:

2. Create a new folder named Models, and within it, create a new class called Employee.cs with the following C# code:

public class Employee
{
  public int Id { get; set; }
  public string Name { get; set; }
  public string Position { get; set; }
}

3. Create an EmployeesDbContext class in a new folder called Data with the following code:

public class EmployeesDbContext : DbContext
{
  public DbSet<Employee> Employees { get; set; }

  protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
  {
    optionsBuilder.UseSqlServer("your_connection_string_here");
  }
}

Replace "your_connection_string_here" with your actual database connection string.

Adding the API Controller

4. Create a new folder called Controllers and add a new class called EmployeesController.cs with the following code:

[ApiController]
[Route≤"api/[controller]")]
public class EmployeesController : ControllerBase
{
  private readonly EmployeesDbContext _ctx;

  public EmployeesController(EmployeesDbContext ctx)
  {
    _ctx = ctx;
  }

  [HttpGet]
  public async Task<ActionResult<IEnumerable<Employee>>> GetEmployees()
  {
    return await _ctx.Employees.ToListAsync();
  }
}

This code creates a simple API controller that returns a list of employees when accessed via a GET request to the /api/employees endpoint.

Running the Web API

5. Run the following command to launch your Web API:

dotnet run

Now, open a web browser or use tools like Postman or curl to send a GET request to http://localhost:5001/api/employees. You should see a list of employees returned in JSON format.

Expanding the Web API

ASP.NET Core Web API provides numerous features for building robust and scalable APIs. Explore these features, such as:

Authentication and Authorization

Secure your APIs by implementing authentication and authorization, ensuring that only authorized users can access your API endpoints.

Model Validation

Validate incoming data using Data Annotations or custom validation attributes to maintain data integrity and ensure the consistency of your API responses.

As you've witnessed, ASP.NET Core Web API offers a powerful and efficient platform for developing modern web APIs. This guide merely scratched the surface of the framework's capabilities. Explore the official documentation and example projects to take your learning to the next level.

Happy coding, and may your Web APIs soar!