From 1ea0a16317973df707ad16dcb3e916ebb9e1a13e Mon Sep 17 00:00:00 2001 From: transtrike Date: Thu, 25 Feb 2021 12:48:30 +0200 Subject: Updated Nuget packages; Added Swagger packages for further documentation improvement --- src/Web/DevHive.Web/DevHive.Web.csproj | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'src/Web/DevHive.Web/DevHive.Web.csproj') diff --git a/src/Web/DevHive.Web/DevHive.Web.csproj b/src/Web/DevHive.Web/DevHive.Web.csproj index 6511c37..53f354e 100644 --- a/src/Web/DevHive.Web/DevHive.Web.csproj +++ b/src/Web/DevHive.Web/DevHive.Web.csproj @@ -14,12 +14,16 @@ all - + + + + + -- cgit v1.2.3 From d841eada42e0f1f08f488a24752d2f2ae090cb53 Mon Sep 17 00:00:00 2001 From: transtrike Date: Thu, 25 Feb 2021 18:51:29 +0200 Subject: Initial Swagger configuration setup --- .../Configurations/Extensions/ConfigureSwagger.cs | 36 ++++++++++++++++++++-- src/Web/DevHive.Web/DevHive.Web.csproj | 3 +- 2 files changed, 35 insertions(+), 4 deletions(-) (limited to 'src/Web/DevHive.Web/DevHive.Web.csproj') diff --git a/src/Web/DevHive.Web/Configurations/Extensions/ConfigureSwagger.cs b/src/Web/DevHive.Web/Configurations/Extensions/ConfigureSwagger.cs index a0641ab..bfa44b0 100644 --- a/src/Web/DevHive.Web/Configurations/Extensions/ConfigureSwagger.cs +++ b/src/Web/DevHive.Web/Configurations/Extensions/ConfigureSwagger.cs @@ -1,23 +1,53 @@ +using System; +using System.IO; +using System.Linq; +using System.Reflection; using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.DependencyInjection; using Microsoft.OpenApi.Models; +using Swashbuckle.AspNetCore.SwaggerGen; namespace DevHive.Web.Configurations.Extensions { public static class SwaggerExtensions { +#pragma warning disable S1075 + private const string LicenseName = "GPL-3.0 License"; + private const string LicenseUri = "https://github.com/Team-Kaleidoscope/DevHive/blob/main/LICENSE"; + private const string TermsOfServiceUri = "https://example.com/terms"; +#pragma warning restore S1075 + public static void SwaggerConfiguration(this IServiceCollection services) { services.AddSwaggerGen(c => { - c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" }); + c.SwaggerDoc("v0.1", new OpenApiInfo + { + Version = "v0.1", + Title = "API", + Description = "DevHive Social Media's first official API release", + TermsOfService = new Uri(TermsOfServiceUri), + License = new OpenApiLicense + { + Name = LicenseName, + Url = new Uri(LicenseUri) + } + }); + + string xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; + string xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); + c.IncludeXmlComments(xmlPath); }); } public static void UseSwaggerConfiguration(this IApplicationBuilder app) { app.UseSwagger(); - app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "API v1")); + app.UseSwaggerUI(c => + { + c.SwaggerEndpoint("/swagger/v0.1/swagger.json", "v0.1"); + }); } } -} \ No newline at end of file +} diff --git a/src/Web/DevHive.Web/DevHive.Web.csproj b/src/Web/DevHive.Web/DevHive.Web.csproj index 53f354e..6956613 100644 --- a/src/Web/DevHive.Web/DevHive.Web.csproj +++ b/src/Web/DevHive.Web/DevHive.Web.csproj @@ -5,6 +5,7 @@ true latest + true @@ -29,4 +30,4 @@ - \ No newline at end of file + -- cgit v1.2.3 From 784b5fc621f71fa94eddf276b0b932ba7d1aa873 Mon Sep 17 00:00:00 2001 From: transtrike Date: Fri, 26 Feb 2021 23:23:38 +0200 Subject: Fixed Project Restore Problem "Not Found" --- src/Common/DevHive.Common/DevHive.Common.csproj | 4 +-- .../DevHive.Services.Models.csproj | 9 +++--- .../DevHive.Services.Tests.csproj | 18 ++++++------ .../DevHive.Services/DevHive.Services.csproj | 20 ++++++++------ .../DevHive.Web.Models/DevHive.Web.Models.csproj | 9 +++--- src/Web/DevHive.Web.Tests/DevHive.Web.Tests.csproj | 16 ++++++----- src/Web/DevHive.Web/DevHive.Web.csproj | 32 ++++++++++++---------- 7 files changed, 59 insertions(+), 49 deletions(-) (limited to 'src/Web/DevHive.Web/DevHive.Web.csproj') diff --git a/src/Common/DevHive.Common/DevHive.Common.csproj b/src/Common/DevHive.Common/DevHive.Common.csproj index 7ec20b1..cd60d85 100644 --- a/src/Common/DevHive.Common/DevHive.Common.csproj +++ b/src/Common/DevHive.Common/DevHive.Common.csproj @@ -1,6 +1,6 @@ - + net5.0 @@ -8,4 +8,4 @@ - \ No newline at end of file + diff --git a/src/Services/DevHive.Services.Models/DevHive.Services.Models.csproj b/src/Services/DevHive.Services.Models/DevHive.Services.Models.csproj index 914efe0..6bbc60e 100644 --- a/src/Services/DevHive.Services.Models/DevHive.Services.Models.csproj +++ b/src/Services/DevHive.Services.Models/DevHive.Services.Models.csproj @@ -3,10 +3,11 @@ net5.0 - - + + - + + - \ No newline at end of file + diff --git a/src/Services/DevHive.Services.Tests/DevHive.Services.Tests.csproj b/src/Services/DevHive.Services.Tests/DevHive.Services.Tests.csproj index 747a730..b3d0a32 100644 --- a/src/Services/DevHive.Services.Tests/DevHive.Services.Tests.csproj +++ b/src/Services/DevHive.Services.Tests/DevHive.Services.Tests.csproj @@ -4,18 +4,20 @@ false - - - - - - + + + + + + - + + + true latest - \ No newline at end of file + diff --git a/src/Services/DevHive.Services/DevHive.Services.csproj b/src/Services/DevHive.Services/DevHive.Services.csproj index 650a304..55d9d4e 100644 --- a/src/Services/DevHive.Services/DevHive.Services.csproj +++ b/src/Services/DevHive.Services/DevHive.Services.csproj @@ -3,23 +3,25 @@ net5.0 - + runtime; build; native; contentfiles; analyzers; buildtransitive all - - - - - + + + + + - - + + + + true latest - \ No newline at end of file + diff --git a/src/Web/DevHive.Web.Models/DevHive.Web.Models.csproj b/src/Web/DevHive.Web.Models/DevHive.Web.Models.csproj index 64d0bd0..7f3f577 100644 --- a/src/Web/DevHive.Web.Models/DevHive.Web.Models.csproj +++ b/src/Web/DevHive.Web.Models/DevHive.Web.Models.csproj @@ -3,10 +3,11 @@ net5.0 - + + - - + + - \ No newline at end of file + diff --git a/src/Web/DevHive.Web.Tests/DevHive.Web.Tests.csproj b/src/Web/DevHive.Web.Tests/DevHive.Web.Tests.csproj index 22173ee..41afbd4 100644 --- a/src/Web/DevHive.Web.Tests/DevHive.Web.Tests.csproj +++ b/src/Web/DevHive.Web.Tests/DevHive.Web.Tests.csproj @@ -4,17 +4,19 @@ false - - - - - + + + + + - + + + true latest - \ No newline at end of file + diff --git a/src/Web/DevHive.Web/DevHive.Web.csproj b/src/Web/DevHive.Web/DevHive.Web.csproj index 6956613..a5b68ce 100644 --- a/src/Web/DevHive.Web/DevHive.Web.csproj +++ b/src/Web/DevHive.Web/DevHive.Web.csproj @@ -8,26 +8,28 @@ true - - + + runtime; build; native; contentfiles; analyzers; buildtransitive all - - - - - - - - - - - + + + + + + + + + + + - - + + + + -- cgit v1.2.3