thomas.nuyken/vegasco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Specify API returns types for swagger

Browse Source
This commit is contained in:
Thomas Nuyken
2025-06-16 20:28:37 +02:00
parent b989c43ec3
commit bcbf76fda6
10 changed files with 35 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Vegasco.Server.Api/Cars/CreateCar.cs
View File

@@ -16,7 +16,9 @@ public static class CreateCar
{ {
return builder return builder
.MapPost("cars", Endpoint) .MapPost("cars", Endpoint)
.WithTags("Cars"); .WithTags("Cars")
.Produces<Response>(201)
.ProducesValidationProblem();
} }
public class Validator : AbstractValidator<Request> public class Validator : AbstractValidator<Request>

4
src/Vegasco.Server.Api/Cars/DeleteCar.cs
View File

@@ -8,7 +8,9 @@ public static class DeleteCar
{ {
return builder return builder
.MapDelete("cars/{id:guid}", Endpoint) .MapDelete("cars/{id:guid}", Endpoint)
.WithTags("Cars"); .WithTags("Cars")
.Produces(204)
.Produces(404);
} }
public static async Task<IResult> Endpoint( public static async Task<IResult> Endpoint(

10
src/Vegasco.Server.Api/Cars/GetCar.cs
View File

@@ -1,4 +1,5 @@
using Vegasco.Server.Api.Persistence; using Microsoft.AspNetCore.Http.HttpResults;
using Vegasco.Server.Api.Persistence;
namespace Vegasco.Server.Api.Cars; namespace Vegasco.Server.Api.Cars;
@@ -10,7 +11,10 @@ public static class GetCar
{ {
return builder return builder
.MapGet("cars/{id:guid}", Endpoint) .MapGet("cars/{id:guid}", Endpoint)
.WithTags("Cars"); .WithDescription("Returns a single car by ID")
.WithTags("Cars")
.Produces<Response>()
.Produces(404);
} }
private static async Task<IResult> Endpoint( private static async Task<IResult> Endpoint(
@@ -28,4 +32,4 @@ public static class GetCar
var response = new Response(car.Id.Value, car.Name); var response = new Response(car.Id.Value, car.Name);
return TypedResults.Ok(response); return TypedResults.Ok(response);
} }
} }

5
src/Vegasco.Server.Api/Cars/GetCars.cs
View File

@@ -25,10 +25,11 @@ public static class GetCars
return builder return builder
.MapGet("cars", Endpoint) .MapGet("cars", Endpoint)
.WithDescription("Returns all cars") .WithDescription("Returns all cars")
.WithTags("Cars"); .WithTags("Cars")
.Produces<ApiResponse>();
} }
private static async Task<Ok<ApiResponse>> Endpoint( private static async Task<IResult> Endpoint(
[AsParameters] Request request, [AsParameters] Request request,
ApplicationDbContext dbContext, ApplicationDbContext dbContext,
CancellationToken cancellationToken) CancellationToken cancellationToken)

5
src/Vegasco.Server.Api/Cars/UpdateCar.cs
View File

@@ -15,7 +15,10 @@ public static class UpdateCar
{ {
return builder return builder
.MapPut("cars/{id:guid}", Endpoint) .MapPut("cars/{id:guid}", Endpoint)
.WithTags("Cars"); .WithTags("Cars")
.Produces<Response>()
.ProducesValidationProblem()
.Produces(404);
} }
public class Validator : AbstractValidator<Request> public class Validator : AbstractValidator<Request>

3
src/Vegasco.Server.Api/Consumptions/CreateConsumption.cs
View File

@@ -16,7 +16,8 @@ public static class CreateConsumption
{ {
return builder return builder
.MapPost("consumptions", Endpoint) .MapPost("consumptions", Endpoint)
.WithTags("Consumptions"); .WithTags("Consumptions")
.Produces<Response>(201);
} }
public class Validator : AbstractValidator<Request> public class Validator : AbstractValidator<Request>

4
src/Vegasco.Server.Api/Consumptions/DeleteConsumptions.cs
View File

@@ -8,7 +8,9 @@ public static class DeleteConsumption
{ {
return builder return builder
.MapDelete("consumptions/{id:guid}", Endpoint) .MapDelete("consumptions/{id:guid}", Endpoint)
.WithTags("Consumptions"); .WithTags("Consumptions")
.Produces(204)
.Produces(404);
} }
private static async Task<IResult> Endpoint( private static async Task<IResult> Endpoint(

4
src/Vegasco.Server.Api/Consumptions/GetConsumption.cs
View File

@@ -10,7 +10,9 @@ public static class GetConsumption
{ {
return builder return builder
.MapGet("consumptions/{id:guid}", Endpoint) .MapGet("consumptions/{id:guid}", Endpoint)
.WithTags("Consumptions"); .WithTags("Consumptions")
.Produces<Response>()
.Produces(404);
} }
private static async Task<IResult> Endpoint( private static async Task<IResult> Endpoint(

5
src/Vegasco.Server.Api/Consumptions/GetConsumptions.cs
View File

@@ -31,7 +31,8 @@ public static class GetConsumptions
return builder return builder
.MapGet("consumptions", Endpoint) .MapGet("consumptions", Endpoint)
.WithDescription("Returns all consumption entries") .WithDescription("Returns all consumption entries")
.WithTags("Consumptions"); .WithTags("Consumptions")
.Produces<ApiResponse>();
} }
private static async Task<Ok<ApiResponse>> Endpoint( private static async Task<Ok<ApiResponse>> Endpoint(
@@ -44,7 +45,7 @@ public static class GetConsumptions
new ResponseDto(x.Id.Value, x.DateTime, x.Distance, x.Amount, x.IgnoreInCalculation, x.CarId.Value)) new ResponseDto(x.Id.Value, x.DateTime, x.Distance, x.Amount, x.IgnoreInCalculation, x.CarId.Value))
.ToListAsync(cancellationToken); .ToListAsync(cancellationToken);
var apiResponse = new ApiResponse ApiResponse apiResponse = new()
{ {
Consumptions = consumptions Consumptions = consumptions
}; };

5
src/Vegasco.Server.Api/Consumptions/UpdateConsumption.cs
View File

@@ -15,7 +15,10 @@ public static class UpdateConsumption
{ {
return builder return builder
.MapPut("consumptions/{id:guid}", Endpoint) .MapPut("consumptions/{id:guid}", Endpoint)
.WithTags("Consumptions"); .WithTags("Consumptions")
.Produces<Response>()
.ProducesValidationProblem()
.Produces(404);
} }
public class Validator : AbstractValidator<Request> public class Validator : AbstractValidator<Request>