https://github.com/estherslabbert/todolist.api
Basic ToDo C# WebApplication API with SQL Server database
https://github.com/estherslabbert/todolist.api
api asp-net-core-web-api csharp entityframeworkcore sql-server
Last synced: 11 months ago
JSON representation
Basic ToDo C# WebApplication API with SQL Server database
- Host: GitHub
- URL: https://github.com/estherslabbert/todolist.api
- Owner: EstherSlabbert
- Created: 2025-03-03T09:59:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-03T10:07:48.000Z (11 months ago)
- Last Synced: 2025-03-03T11:23:54.992Z (11 months ago)
- Topics: api, asp-net-core-web-api, csharp, entityframeworkcore, sql-server
- Language: C#
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ToDoList API Web App
ASP.NET Web API ToDoList App using SqlServer database.
This app enables you to track basic information about projects with associated todos in a Sql Server database and manages this via an API that makes use of controllers and manages data via EntityFrameworkCore (the recommended Object-Relational Mapper (ORM) for .NET).
## Initial set up and discovery
1. Create a new project with VisualStudio selecting the following settings:
Template: ASP.NET Core Web API
Name: Whatever you want to name your project
Framework: .NET 8.0 (Long Term Support)
Authentication: None
- [x] Configure for HTTPS
- [ ] Enable container support
- [x] Enable OpenApi support
- [ ] Do not use top level statements
- [x] Use controllers
- [ ] Enlist in .NET Aspire orchestration
2. Use NuGet Package Manager to install:
- Microsoft.EntityFrameworkCore.SqlServer (Version 8.0.0)
- Microsoft.EntityFrameworkCore.Tools (Version 8.0.0)
3. Set up a new entity (in this project, a class called `Project` and `ToDo`) with the necessary properties.
4. Add a new controller for getting all the superheroes with dummy data to return from the controller itself as a placeholder for now.
5. Set up your `DataContext` file, which creates a class that inherits from `DbContext` and add your context options to the constructor and a new table in the form of `DbSet` and `DbSet`.
6. Set your connection strings in the `appsettings.json` file.
7. Update `Program.cs` file with the database context like follows:
```csharp
builder.Services.AddDbContext(options =>
{
options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"));
});
```
8. Open the Package Manager Console and enter the following commands:
`Add-Migration Initial` Initial is the name of the migration that will be automatically generated and stored in the Migrations folder
then `Update-Database` which applies the migrations to the database.
Note: These commands ensure the database has the needful table(s) and when new tables need to be added similar commands need to be run from the Package Manager Console `Add-Migration NameOfMigration` then `Update-Database` (to do the update on a specific migration you need to use the `Update-Database NameOfMigration`) OR via the command line once ef tool is installed using `dotnet tool install --global dotnet-ef` command, then `dotnet ef migrations add AddUnhandledExceptionTable --project Superhero --startup-project Superhero` then `dotnet ef database update`. See [LearnEntityFrameworkCore](https://www.learnentityframeworkcore.com/) for more details.
9. Now set up the controller to use the database with the DataContext as an entry point. Get the controller working as desired then add other controllers for CRUD operations.
10. Clean up unneeded files.
11. Separate out files and methods into projects as dependency injections and services to be used etc.
12. Add tests.