Add Swagger annotations

jonathanpotts · Feb 6, 2024 · a861cc7 · a861cc7
1 parent 9469308
commit a861cc7
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ Recipe Catalog is a [.NET](https://dotnet.microsoft.com/) 8 project showcasing a
     - [Migrations](https://learn.microsoft.com/ef/core/managing-schemas/migrations/)
     - [SQLite](https://www.sqlite.org/)
 - [FluentValidation](https://github.com/FluentValidation/FluentValidation)
+- [Swagger / OpenAPI](https://swagger.io/) ([Swashbuckle](https://github.com/domaindrivendev/Swashbuckle.AspNetCore))
 - Markdown ([Markdig](https://github.com/xoofx/markdig))
 - Snowflake IDs ([IdGen](https://github.com/RobThree/IdGen))
 

diff --git a/src/WebApi/Apis/RecipesApi.cs b/src/WebApi/Apis/RecipesApi.cs
@@ -10,6 +10,7 @@
 using Microsoft.AspNetCore.Identity;
 using Microsoft.EntityFrameworkCore;
 using SharpGrip.FluentValidation.AutoValidation.Endpoints.Extensions;
+using Swashbuckle.AspNetCore.Annotations;
 
 namespace JonathanPotts.RecipeCatalog.WebApi.Apis;
 
@@ -144,6 +145,7 @@ public static async Task<Results<Ok<RecipeWithCuisineDto>, NotFound>> GetAsync(
         });
     }
 
+    [SwaggerResponse(200, contentTypes: "image/webp")]
     public static async Task<Results<PhysicalFileHttpResult, NotFound>> GetCoverImageAsync(
         [AsParameters] Services services,
         long id)

diff --git a/src/WebApi/Program.cs b/src/WebApi/Program.cs
@@ -36,6 +36,8 @@
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen(c =>
 {
+    c.EnableAnnotations();
+
     c.AddSecurityDefinition("Identity", new OpenApiSecurityScheme
     {
         In = ParameterLocation.Header,

diff --git a/src/WebApi/README.md b/src/WebApi/README.md
@@ -10,6 +10,7 @@ WebApi is a REST Web API that provides CRUD operations for managing recipes. Tec
     - [Migrations](https://learn.microsoft.com/ef/core/managing-schemas/migrations/)
     - [SQLite](https://www.sqlite.org/)
 - [FluentValidation](https://github.com/FluentValidation/FluentValidation)
+- [Swagger / OpenAPI](https://swagger.io/) ([Swashbuckle](https://github.com/domaindrivendev/Swashbuckle.AspNetCore))
 - Markdown ([Markdig](https://github.com/xoofx/markdig))
 - Snowflake IDs ([IdGen](https://github.com/RobThree/IdGen))
 

diff --git a/src/WebApi/WebApi.csproj b/src/WebApi/WebApi.csproj
@@ -30,6 +30,7 @@
     </PackageReference>
     <PackageReference Include="SharpGrip.FluentValidation.AutoValidation.Endpoints" Version="1.4.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0" />
     <PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="8.0.0" />
   </ItemGroup>