58 lines
2.4 KiB
C#
58 lines
2.4 KiB
C#
using System;
|
|
using Microsoft.AspNetCore.Mvc.ApiExplorer;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Options;
|
|
using Microsoft.OpenApi.Models;
|
|
using Swashbuckle.AspNetCore.SwaggerGen;
|
|
|
|
namespace OnlineAssessment
|
|
{
|
|
/// <summary>
|
|
/// Configures the Swagger generation options.
|
|
/// </summary>
|
|
/// <remarks>This allows API versioning to define a Swagger document per API version after the
|
|
/// <see cref="IApiVersionDescriptionProvider"/> service has been resolved from the service container.</remarks>
|
|
public class SwaggerConfigureOptions : IConfigureOptions<SwaggerGenOptions>
|
|
{
|
|
private const string OdiwareApiTitle = "API - TEACHERS";
|
|
private const string OdiwareApiDescription = "Odiware Online Assessment System - RESTful APIs for the users of an institution";
|
|
readonly IApiVersionDescriptionProvider provider;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="SwaggerConfigureOptions"/> class.
|
|
/// </summary>
|
|
/// <param name="provider">The <see cref="IApiVersionDescriptionProvider">provider</see> used to generate Swagger documents.</param>
|
|
public SwaggerConfigureOptions(IApiVersionDescriptionProvider provider) => this.provider = provider;
|
|
|
|
/// <inheritdoc />
|
|
public void Configure(SwaggerGenOptions options)
|
|
{
|
|
// add a swagger document for each discovered API version
|
|
// note: you might choose to skip or document deprecated API versions differently
|
|
foreach (var description in provider.ApiVersionDescriptions)
|
|
{
|
|
options.SwaggerDoc(description.GroupName, CreateInfoForApiVersion(description));
|
|
}
|
|
}
|
|
|
|
static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
|
|
{
|
|
var info = new OpenApiInfo()
|
|
{
|
|
Title = OdiwareApiTitle,
|
|
Version = description.ApiVersion.ToString(),
|
|
Description = OdiwareApiDescription,
|
|
Contact = new OpenApiContact() { Name = "Odiware Technologies", Email = "hr@odiware.com" },
|
|
License = new OpenApiLicense() { Name = "MIT", Url = new Uri("https://opensource.org/licenses/MIT") }
|
|
};
|
|
|
|
if (description.IsDeprecated)
|
|
{
|
|
info.Description += " This API version has been deprecated.";
|
|
}
|
|
|
|
return info;
|
|
}
|
|
}
|
|
}
|