- Notifications
You must be signed in to change notification settings - Fork0
shaydoc/minimal-api-dotnet
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Building a minimal user web api with Entity Framework and SQLite on ASP.NET Web API Core 7
dotnet watch run
This structure reflects a clear separation of concerns and makes your project easy to navigate and maintain.
.├── / # Root directory├── Program.cs # Main entry point for the application├── /ef # Directory for Entity Framework related files│ └── UserContext.cs # EF Core DB Context for User├── /endpoint # Directory for API endpoints│ └── UserEndpoint.cs # API endpoint for User├── /Migrations # Directory for database migration scripts├── /poco # Directory for Plain Old CLR Objects (POCOs) or simple entities│ ├── User.cs # POCO class for User│ └── UserValidator.cs # Class for User validation├── /repository # Directory for repository classes│ ├── IUserRepository.cs # Interface for User repository│ └── UserRepository.cs # Class implementing User repository├── /services # Directory for service classes│ ├── IUserService.cs # Interface for User service│ └── UserService.cs # Class implementing User service└── /wwwroot # Root directory for static files └── /content # Directory for content files └── /data # Directory for database files └── user.db # SQLite database file for User
Sets up the required packages to use SqlLite with .NET 7
# SQL Lite $: dotnet add package Microsoft.Data.Sqlite # Entity Framework Adapter for SQL Lite $: dotnet add package Microsoft.EntityFrameworkCore.Sqlite # Entity Framework Core Design for Migrations $: dotnet add package Microsoft.EntityFrameworkCore.Design # Elegant Model Validation $: dotnet add package FluentValidation.AspNetCore # Open Api Specification for decorating Api's $: dotnet add package Microsoft.AspNetCore.OpenApi # Swashbuckle for Api Documentation $: dotnet add package Swashbuckle.AspNetCoreInappsettings.Development.json and **appsettings.json add
"ConnectionStrings": { "DefaultConnection": "Data Source=./wwwroot/content/data/user.db" },Create awwwroot/content/data directory to host the SQLLite File
Inminimal-api-dotnet.csproj add theItemGroup
<ItemGroup> <Content Update="wwwroot\content\**\*" CopyToPublishDirectory="Never" /> </ItemGroup>FAIR WARNING - publish via FTP will preserve the SQL Lite DB, but it will get blown away if youdeploy via Github Actions, using theuses: actions/upload-artifact@v2 step
See theef directory for the creation of aUserContext, this will be the class that drivesthe EntityFramework. It contains aDbSet<User> for aUser table containing anId and aName.We will run a migration script to add anEmail column also.
Configuring the EntityFramework connection string inProgram.cs makes it a sinch to get up and running,by taking the Connection String from the Configuration we defined previously.
using Microsoft.EntityFrameworkCore;var builder = WebApplication.CreateBuilder(args);builder.Services.AddDbContext<UserContext>(options => options.UseSqlite(builder.Configuration.GetConnectionString("DefaultConnection")));var app = builder.Build();// DI the user service, user validator and the db contextbuilder.Services.AddScoped<IUserService, UserService>();builder.Services.AddScoped<IValidator<User>, UserValidator>();builder.Services.AddScoped<IUserRepository, UserRepository>();In theendpoint directory, create aUserEndpoint static class to map all thehttp methods available.You can then call the EntityFramework directory to fetch from or update the Database table.Endpoint groups allow you to manage API versioning. The Fluent Api enables easy chaining of features such as Cors, Authorization, and Rate Limiting
Program.cs...app.MapGroup("/api/v1/users") .MapGroupOneUserApi() .WithTags("Public")Running a Database Migration to add email to the Users table in the Users Database (already applied)
$: dotnet ef migrations add AddUserEmail$: dotnet ef migrations updateRunning a Database Migration to make email a required field on the Users table in the Users Database (already applied)
$: dotnet ef migrations add UserEmailRequired$: dotnet ef migrations update$: dotnet watch run
http://localhost:5080/swagger/index.html - you can test the api's from here
# Fetch all userscurl http://localhost:5080/api/v1/users# Fetch a single usercurl http://localhost:5080/api/v1/users/18# Add a Usercurl 'http://localhost:5080/api/v1/users' \ -X 'POST' \ -H 'Content-Type: application/json' \ --data-raw '{"name":"Anew User","email":"anewuser@foo.com"}' \ --compressed# Update a Usercurl 'http://localhost:5080/api/v1/users/18' \ -X 'PUT' \ -H 'Content-Type: application/json' \ --data-raw '{"id":"18","name":"Gerry Foo","email":"gerrry@foo.com"}' \ --compressed# Delete a Usercurl 'http://localhost:5080/api/v1/users/18' \ -X 'DELETE' \ -H 'Content-Type: application/json' \ --compressed