Added Card model, updated database initialization, udated readme.
This commit is contained in:
25
README.md
25
README.md
@@ -15,27 +15,40 @@ Follow these steps to set up your local PostgreSQL database:
|
|||||||
If you haven't already, create a database and a user with appropriate permissions. You can use `psql` or a tool like pgAdmin.
|
If you haven't already, create a database and a user with appropriate permissions. You can use `psql` or a tool like pgAdmin.
|
||||||
|
|
||||||
```sql
|
```sql
|
||||||
-- Create the database
|
|
||||||
CREATE DATABASE "SDG-Backend";
|
|
||||||
|
|
||||||
-- Create the user
|
-- Create SDG-Backend-Admin
|
||||||
CREATE USER "SDG-Backend-Admin" WITH ENCRYPTED PASSWORD 'password';
|
CREATE USER "SDG-Backend-Admin" WITH ENCRYPTED PASSWORD 'password';
|
||||||
|
|
||||||
-- Grant privileges
|
-- Create the database
|
||||||
GRANT ALL PRIVILEGES ON DATABASE "SDG-Backend" TO "SDG-Backend-Admin";
|
CREATE DATABASE "SDG-Backend" OWNER "SDG-Backend-Admin";
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Configure Connection String
|
||||||
|
#### Initialize User Secrets
|
||||||
|
Run this in the project directory (`SDG-Backend-Barracuda\SDG-Backend-Barracuda`):
|
||||||
|
```bash
|
||||||
|
dotnet user-secrets init
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Set the Connection String
|
||||||
|
Replace `password` if you used a different one during setup:
|
||||||
|
```bash
|
||||||
|
dotnet user-secrets set "ConnectionStrings:DefaultConnection" "Host=localhost;Database=SDG-Backend;Username=SDG-Backend-Admin;Password=password;Maximum Pool Size=100;"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Installing Dependencies
|
### Installing Dependencies
|
||||||
The project uses `Npgsql` and `Dapper`. These can be installed via:
|
The project uses `Npgsql`, `Dapper`, and `Npgsql.DependencyInjection`.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dotnet add package Npgsql
|
dotnet add package Npgsql
|
||||||
dotnet add package Dapper
|
dotnet add package Dapper
|
||||||
|
dotnet add package Npgsql.DependencyInjection
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the Application
|
### Running the Application
|
||||||
|
From the root directory:
|
||||||
```bash
|
```bash
|
||||||
dotnet run --project SDG-Backend-Barracuda
|
dotnet run --project SDG-Backend-Barracuda
|
||||||
```
|
```
|
||||||
50
SDG-Backend-Barracuda/Models/CardModel.cs
Normal file
50
SDG-Backend-Barracuda/Models/CardModel.cs
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
using Dapper;
|
||||||
|
using Npgsql;
|
||||||
|
|
||||||
|
namespace SDG_Backend_Barracuda.Models;
|
||||||
|
|
||||||
|
public record Card(int Id, string Value);
|
||||||
|
public record CardInput(string Value);
|
||||||
|
|
||||||
|
public interface ICardModel : IDatabaseModel<Card, CardInput>
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
public class CardModel(NpgsqlDataSource dataSource) : ICardModel
|
||||||
|
{
|
||||||
|
public async Task<IEnumerable<Card>> GetAllAsync()
|
||||||
|
{
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
var sql = """SELECT "Id", "Value" FROM "Card";""";
|
||||||
|
return await connection.QueryAsync<Card>(sql);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async Task<Card?> GetByIdAsync(int id)
|
||||||
|
{
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
var sql = """SELECT "Id", "Value" FROM "Card" WHERE "Id" = @Id;""";
|
||||||
|
return await connection.QueryFirstOrDefaultAsync<Card>(sql, new { Id = id });
|
||||||
|
}
|
||||||
|
|
||||||
|
public async Task<Card> CreateAsync(CardInput input)
|
||||||
|
{
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
var sql = """INSERT INTO "Card" ("Value") VALUES (@Value) RETURNING "Id", "Value";""";
|
||||||
|
return await connection.QuerySingleAsync<Card>(sql, input);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async Task<Card?> UpdateAsync(int id, CardInput input)
|
||||||
|
{
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
var sql = """UPDATE "Card" SET "Value" = @Value WHERE "Id" = @Id RETURNING "Id", "Value";""";
|
||||||
|
return await connection.QueryFirstOrDefaultAsync<Card>(sql, new { Id = id, Value = input.Value });
|
||||||
|
}
|
||||||
|
|
||||||
|
public async Task<bool> DeleteAsync(int id)
|
||||||
|
{
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
var sql = """DELETE FROM "Card" WHERE "Id" = @Id;""";
|
||||||
|
var rowsAffected = await connection.ExecuteAsync(sql, new { Id = id });
|
||||||
|
return rowsAffected > 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
10
SDG-Backend-Barracuda/Models/IDatabaseModel.cs
Normal file
10
SDG-Backend-Barracuda/Models/IDatabaseModel.cs
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
namespace SDG_Backend_Barracuda.Models;
|
||||||
|
|
||||||
|
public interface IDatabaseModel<T, in TInput>
|
||||||
|
{
|
||||||
|
Task<IEnumerable<T>> GetAllAsync();
|
||||||
|
Task<T?> GetByIdAsync(int id);
|
||||||
|
Task<T> CreateAsync(TInput input);
|
||||||
|
Task<T?> UpdateAsync(int id, TInput input);
|
||||||
|
Task<bool> DeleteAsync(int id);
|
||||||
|
}
|
||||||
@@ -1,11 +1,34 @@
|
|||||||
|
using Dapper;
|
||||||
|
using Npgsql;
|
||||||
|
using SDG_Backend_Barracuda.Models;
|
||||||
|
|
||||||
var builder = WebApplication.CreateBuilder(args);
|
var builder = WebApplication.CreateBuilder(args);
|
||||||
|
|
||||||
// Add services to the container.
|
// Add services to the container.
|
||||||
// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
|
// Learn more about configuring OpenAPI at https://aka.ms/aspnet/openapi
|
||||||
builder.Services.AddOpenApi();
|
builder.Services.AddOpenApi();
|
||||||
|
|
||||||
|
// Register NpgsqlDataSource
|
||||||
|
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
|
||||||
|
builder.Services.AddNpgsqlDataSource(connectionString!);
|
||||||
|
|
||||||
|
// Register Data Tables
|
||||||
|
builder.Services.AddScoped<ICardModel, CardModel>();
|
||||||
|
|
||||||
var app = builder.Build();
|
var app = builder.Build();
|
||||||
|
|
||||||
|
// Ensure the table exists
|
||||||
|
using (var scope = app.Services.CreateScope())
|
||||||
|
{
|
||||||
|
var dataSource = scope.ServiceProvider.GetRequiredService<NpgsqlDataSource>();
|
||||||
|
await using var connection = await dataSource.OpenConnectionAsync();
|
||||||
|
await connection.ExecuteAsync(@"
|
||||||
|
CREATE TABLE IF NOT EXISTS ""Card"" (
|
||||||
|
""Id"" SERIAL PRIMARY KEY,
|
||||||
|
""Value"" TEXT NOT NULL
|
||||||
|
);");
|
||||||
|
}
|
||||||
|
|
||||||
// Configure the HTTP request pipeline.
|
// Configure the HTTP request pipeline.
|
||||||
if (app.Environment.IsDevelopment())
|
if (app.Environment.IsDevelopment())
|
||||||
{
|
{
|
||||||
@@ -14,28 +37,34 @@ if (app.Environment.IsDevelopment())
|
|||||||
|
|
||||||
app.UseHttpsRedirection();
|
app.UseHttpsRedirection();
|
||||||
|
|
||||||
var summaries = new[]
|
app.MapPost("/card", async (CardInput input, ICardModel card) =>
|
||||||
{
|
{
|
||||||
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
|
var newCard = await card.CreateAsync(input);
|
||||||
};
|
return Results.Created($"/card/{newCard.Id}", newCard);
|
||||||
|
});
|
||||||
|
|
||||||
app.MapGet("/weatherforecast", () =>
|
app.MapGet("/card", async (ICardModel card) =>
|
||||||
{
|
|
||||||
var forecast = Enumerable.Range(1, 5).Select(index =>
|
|
||||||
new WeatherForecast
|
|
||||||
(
|
|
||||||
DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
|
|
||||||
Random.Shared.Next(-20, 55),
|
|
||||||
summaries[Random.Shared.Next(summaries.Length)]
|
|
||||||
))
|
|
||||||
.ToArray();
|
|
||||||
return forecast;
|
|
||||||
})
|
|
||||||
.WithName("GetWeatherForecast");
|
|
||||||
|
|
||||||
app.Run();
|
|
||||||
|
|
||||||
record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
|
|
||||||
{
|
{
|
||||||
public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
|
var result = await card.GetAllAsync();
|
||||||
}
|
return Results.Ok(result);
|
||||||
|
});
|
||||||
|
|
||||||
|
app.MapGet("/card/{id}", async (int id, ICardModel card) =>
|
||||||
|
{
|
||||||
|
var newCard = await card.GetByIdAsync(id);
|
||||||
|
return newCard is not null ? Results.Ok(newCard) : Results.NotFound();
|
||||||
|
});
|
||||||
|
|
||||||
|
app.MapPut("/card/{id}", async (int id, CardInput input, ICardModel card) =>
|
||||||
|
{
|
||||||
|
var newCard = await card.UpdateAsync(id, input);
|
||||||
|
return newCard is not null ? Results.Ok(newCard) : Results.NotFound();
|
||||||
|
});
|
||||||
|
|
||||||
|
app.MapDelete("/card/{id}", async (int id, ICardModel card) =>
|
||||||
|
{
|
||||||
|
var success = await card.DeleteAsync(id);
|
||||||
|
return success ? Results.NoContent() : Results.NotFound();
|
||||||
|
});
|
||||||
|
|
||||||
|
app.Run();
|
||||||
@@ -1,16 +1,18 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<TargetFramework>net10.0</TargetFramework>
|
<TargetFramework>net10.0</TargetFramework>
|
||||||
<Nullable>enable</Nullable>
|
<Nullable>enable</Nullable>
|
||||||
<ImplicitUsings>enable</ImplicitUsings>
|
<ImplicitUsings>enable</ImplicitUsings>
|
||||||
<RootNamespace>SDG_Backend_Barracuda</RootNamespace>
|
<RootNamespace>SDG_Backend_Barracuda</RootNamespace>
|
||||||
</PropertyGroup>
|
<UserSecretsId>7ceb2efb-dc1a-496c-aa6c-18efbd2a3411</UserSecretsId>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="Dapper" Version="2.1.66" />
|
<PackageReference Include="Dapper" Version="2.1.66" />
|
||||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.1" />
|
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.1" />
|
||||||
<PackageReference Include="Npgsql" Version="10.0.1" />
|
<PackageReference Include="Npgsql" Version="10.0.1" />
|
||||||
|
<PackageReference Include="Npgsql.DependencyInjection" Version="10.0.1" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
|
|||||||
@@ -1,6 +1,28 @@
|
|||||||
@SDG_Backend_Barracuda_HostAddress = http://localhost:5164
|
@SDG_Backend_Barracuda_HostAddress = http://localhost:5164
|
||||||
|
|
||||||
GET {{SDG_Backend_Barracuda_HostAddress}}/weatherforecast/
|
### Get all cards
|
||||||
|
GET {{SDG_Backend_Barracuda_HostAddress}}/card/
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
|
|
||||||
###
|
### Create a new card
|
||||||
|
POST {{SDG_Backend_Barracuda_HostAddress}}/card
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"value": "Sample Card Value"
|
||||||
|
}
|
||||||
|
|
||||||
|
### Get a card by ID
|
||||||
|
GET {{SDG_Backend_Barracuda_HostAddress}}/card/1
|
||||||
|
Accept: application/json
|
||||||
|
|
||||||
|
### Update a card
|
||||||
|
PUT {{SDG_Backend_Barracuda_HostAddress}}/card/1
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"value": "Updated Card Value"
|
||||||
|
}
|
||||||
|
|
||||||
|
### Delete a card
|
||||||
|
DELETE {{SDG_Backend_Barracuda_HostAddress}}/card/1
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
{
|
{
|
||||||
|
"ConnectionStrings": {
|
||||||
|
"DefaultConnection": ""
|
||||||
|
},
|
||||||
"Logging": {
|
"Logging": {
|
||||||
"LogLevel": {
|
"LogLevel": {
|
||||||
"Default": "Information",
|
"Default": "Information",
|
||||||
|
|||||||
Reference in New Issue
Block a user