# Assignment
Build up a REST API using Dotnet Minimal APIs. Your API should be able to handle data about Star Wars characters.
A character is described by these properties:
- Name
- Faction
- Homeworld
- Species
For example:
{
"id": 1,
"name": "Luke Skywalker",
"faction": "Rebel Alliance",
"homeworld": "Tatooine",
"species": "Human"
}{
"id": 2,
"name": "Darth Vader",
"faction": "Galactic Empire",
"homeworld": "Tatooine",
"species": "Human"
}{
"id": 3,
"name": "R2-D2",
"faction": "Rebel Alliance",
"homeworld": "Naboo",
"species": "Droid"
}In C# we use PascalCase for property identifiers. In JSON it is more commen tu use camelCase identifiers. ASP.NET’s default serialization/deserialization behavior is to convert the casings, so that a PascalCase property will be serialized as camelCase field in JSON and vice-versa. So you can create your C# classes with normal PascalCase identifiers (Id, Name, Faction, …)
The single resource of your API is /sw-characters. You should support these endpoints:
# GET /sw-characters
Returns all available characters.
# Filters
It should be possible to filter by faction, homeworld or species using query parameters: GET /sw-characters?faction=Rebel%20Alliance - returns all characters that belong to the Rebel Alliance GET /sw-characters?homeworld=Naboo - returns all characters with Naboo as homeworld GET /sw-characters?species=Human - returns all human characters
# GET /sw-characters/{id}
Returns a specific character by ID.
# POST /sw-characters
Everytime gives a new ID.
Insert a new entry into the list of characters. When sending the request, your JSON body should not contain an id Property and if it does it should be ignored by the API. The API will assign a new ID automatically and return the assigned ID in the response.
# PUT /sw-characters/{id}
Update a specific character by ID (The ID itself should not be changed).
# DELETE /sw-characters/{id}
Delete a character by ID.
# Storing data
Usually you would want to persist data managed by an API on some sort of database. For this exercise it is sufficient to store the data in memory (e.g. using a static List of characters) that will be accessed/modified by the requests.
# Request and response data
Every request and response should be formatted as JSON. It is up to you however how you design the messages. Think about what information is needed in each request/response. For example where do you need IDs in the message body?
# Tests
-
- own project for unit-tests
Test your API manually by using Postman. Additionally write automated unit tests. Set up a unit test project where you try a few tests. For example: Insert an entry and try to get it again. Delete it afterwards and try to get it again, it should not be possible. Each endpoint and functionality should be tested by one or more unit tests.
For being able to unit-test your handlers, your handlers should be publicly accessible from the unit test project. You can achieve this by following the structure outlined in Dotnet Minimal APIs > Structuring Example.
# Solution
Here you can find the source code to programm a minimal API with the requirements from above.
Code for Programm.cs
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
API_Endpoint.Map(app);
app.Run();Code for API_Endpoint
namespace StarWarsAPI_Playground;
public class API_Endpoint
{
private static int CharacterCount = 3;
public static List<Character> characters = new List<Character>();
public static void AddToCharacters()
{
var char1 = new Character()
{
ID = 1,
Name = "Luke Skywalker",
Faction = "Rebel Alliance",
Homeworld = "Tatooine",
Species = "Human"
};
var char2 = new Character()
{
ID = 2,
Name = "Darth Vader",
Faction = "Galactic Empire",
Homeworld = "Tatooine",
Species = "Human"
};
var char3 = new Character()
{
ID = 3,
Name = "R2-D2",
Faction = "Rebel Alliance",
Homeworld = "Naboo",
Species = "Droid"
};
characters.Add(char1);
characters.Add(char2);
characters.Add(char3);
}
public static void Map(WebApplication app)
{
AddToCharacters();
var filteredCharacters = characters;
// alle GETs
app.MapGet("/sw-characters/{id}", (int id) => characters.FirstOrDefault(c => c.ID == id));
app.MapGet("/sw-characters", (string? faction, string? homeworld, string? species) =>
{
if (!string.IsNullOrWhiteSpace(faction))
{
filteredCharacters = filteredCharacters.Where(c => c.Faction == faction).ToList();
}
if (!string.IsNullOrWhiteSpace(homeworld))
{
filteredCharacters = filteredCharacters.Where(c => c.Homeworld == homeworld).ToList();
}
if (!string.IsNullOrWhiteSpace(species))
{
filteredCharacters = filteredCharacters.Where(c => c.Species == species).ToList();
}
return filteredCharacters;
});
// POST
app.MapPost("/sw-characters", (Character newC) =>
{
newC.ID = CharacterCount++;
characters.Add(newC);
return newC;
});
// PUT Befehl
app.MapPut("/sw-characters/{id}", (int id, Character newC) =>
{
var existingCharacter = characters.FirstOrDefault(c => c.ID == id);
if (existingCharacter != null)
{
existingCharacter.Name = newC.Name;
existingCharacter.Faction = newC.Faction;
existingCharacter.Homeworld = newC.Homeworld;
existingCharacter.Species = newC.Species;
return Results.Ok(existingCharacter);
}
return Results.NotFound();
});
app.MapDelete("/sw-characters/{id}", (int id) =>
{
var existingCharacter = characters.FirstOrDefault(c => c.ID == id);
if (existingCharacter != null)
{
characters.Remove(existingCharacter);
return Results.NoContent();
}
return Results.NotFound();
});
}
}
public class Character
{
public int ID { get; set; }
public string Name { get; set; }
public string Faction { get; set; }
public string Homeworld { get; set; }
public string Species { get; set; }
}