MasterZdran Rest API Extensions

Presenting MasterZdran Rest API Extensions, a humble yet invaluable NuGet library crafted with the intention to simplify the journey of web API and REST API development.

Within its modest confines lie a collection of extension methods and models meticulously tailored to ease the burdensome tasks often encountered in API creation.

MasterZdran Rest API Extensions humbly offers developers a reliable toolkit to navigate through common challenges, offering assistance in configuring Swashbuckle Swagger, api paging and more.

With MasterZdran Rest API Extensions by your side, you can bid farewell to tedious, repetitive coding and embrace a more efficient, enjoyable development experience.

API PAGING

[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get([FromQuery] ApiPaging paging)
{
    return Enumerable.Range(paging.FirstRecord, paging.PageSize).Select(index => new WeatherForecast
    {
        Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = s_summaries[index]
    })
    .ToArray();
}

1. The DEFAULT PAGE SIZE is 20, and the MAX PAGE SIZE is 50. If the value is negative or greater than MAX PAGE SIZE, by default return DEFAULT PAGE SIZE.
2. The PAGE NUMBER is zero based index. If the value is negative, by default return page 0.
3. 'ORDERED FIELD', is the field the client want to results ordered, 'ORDERED BY' should be set also.
4. None of the fields are mandatory.

HTTP Media Types Constants (HttpMediaTypes)

        [HttpGet(Name = "GetWeatherForecast")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        [Produces(HttpMediaTypes.ApplicationJson)] // <<---- 
        public IEnumerable<WeatherForecast> Get([FromQuery] ApiPaging paging)
        {
            // ...
        }

Generic API (GET) Response (ResponseType)

        [HttpGet(Name = "GetWeatherForecast")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        [Produces(HttpMediaTypes.ApplicationJson)]
        public ResponseType<WeatherForecast> Get([FromQuery] ApiPaging paging) // <<---- 
        {
            var response = new ResponseType<WeatherForecast>(); // <<---- 

            response.TotalNumberOfRecords = s_summaries.Length;
            response.Results = Enumerable.Range(paging.FirstRecord, paging.PageSize).Select(index => new WeatherForecast
            {
                Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
                TemperatureC = Random.Shared.Next(-20, 55),
                Summary = s_summaries[index]
            })
            .ToArray();

            return response;
        }

Swashbuckle Extensions

This is the first attempt to simplify the "basic" configuration of Swashbuckle Swagger in the projects. Most projects are pretty straight away, with the same configurations. Instead of copying pasting those configurations, this library offer a simple interface and expect the appsettings being properly set for the flow it self.

Also offer the flexibility to create new "configurations" keeping the appsettings structure.

CSPROJ Configurations

  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <NoWarn>$(NoWarn);1591</NoWarn>
  </PropertyGroup>

APPSETTINGS Configurations

scopes key value pair:

key = scope
value = descriptions

if the scope key has ':' character should be replace by '\_\_'. This will be translated by the extension to ':'.

Complete appSettings Section

  "SwaggerOptions": {
    "OpenApiInfo": {
      "Title": "ToDo API",
      "Description": "A simple example ASP.NET Core Web API",
      "Version": "v1",
      "TermsOfService": "https://example.com/terms",
      "Contact": {
        "Name": "Shayne Boyer",
        "Email": "[email protected]",
        "Url": "https://twitter.com/spboyer"
      },
      "License": {
        "Name": "Use under LICX",
        "Url": "https://example.com/license"
      }
    },
    "OpenApiSecurityScheme": {
      "Type": "OAuth2",
      "Description": " OAuth2.0 Auth Code with PKCE",
      "Name": " oauth2",
      "Flows": {
        "Implicit": {
         "AuthorizationUrl": "",
         "TokenUrl": "",
         "RefreshUrl": "",
         "Scopes": {
           "": ""
         }
        },
        "Password": {
         "AuthorizationUrl": "",
         "TokenUrl": "",
         "RefreshUrl": "",
         "Scopes": {
           "": ""
         }
        },
        "ClientCredentials": {
         "AuthorizationUrl": "",
         "TokenUrl": "",
         "RefreshUrl": "",
         "Scopes": {
           "": ""
         }
        },
        "AuthorizationCode": {
          "AuthorizationUrl": "",
          "TokenUrl": "",
          "RefreshUrl": "",
          "Scopes": {
          }
        }
      }
    },
    "SwaggerEndpoint": "",
    "ApiName": "",
    "Name": "",
    "OpenIdClientId": "",
    "XmlFile": "",
    "ApiKeyHeader": "",
    "ApiKeyHeaderToken": ""
  },

"SwaggerOptions":"OpenApiInfo"

OpenApi Swagger metadata information. Should be as complete as possible.

    "OpenApiInfo": {
      "Title": "ToDo API",
      "Description": "A simple example ASP.NET Core Web API",
      "Version": "v1",
      "TermsOfService": "https://example.com/terms",
      "Contact": {
        "Name": "Shayne Boyer",
        "Email": "[email protected]",
        "Url": "https://twitter.com/spboyer"
      },
      "License": {
        "Name": "Use under LICX",
        "Url": "https://example.com/license"
      }
    },

Swagger complementaty appsettigs

{
  "SwaggerEndpoint": "",
  "ApiName": "",
  "Name": "",
  "OpenIdClientId": "",
  "XmlFile": ""
}


## OAuth Flows

### OAuth2 Implicit Flow appsettings

```json
Flow{
  "Implicit": {
    "AuthorizationUrl": "",
    "TokenUrl": "",
    "RefreshUrl": "",
    "Scopes": {
      "key": "value"
    }
  }
}

OAuth2 Password Flow appsettings

Flow{
  "Password": {
    "AuthorizationUrl": "",
    "TokenUrl": "",
    "RefreshUrl": "",
    "Scopes": {
      "key": "value"
    }
  }
}

OAuth2 ClientCredentials Flow appsettings

Flow{
  "ClientCredentials": {
    "AuthorizationUrl": "",
    "TokenUrl": "",
    "RefreshUrl": "",
    "Scopes": {
      "key": "value"
    }
  }
}

OAuth2 AuthorizationCode Flow appsettings

Flow{
  "AuthorizationCode": {
    "AuthorizationUrl": "",
    "TokenUrl": "",
    "RefreshUrl": "",
    "Scopes": {
      "key": "value"
    }
  }
}

OAuth2 APIKEY Flow appsettings

{
  "ApiKeyHeader": "X-API-KEY",
  "ApiKeyHeaderToken": "APITOKEN"
}

Code Samples

OAuth2 Authorization

Program.cs

// Get Options
SwaggerExtensionsOptions swaggerOptions = new SwaggerExtensionsOptions();
builder.Configuration.GetSection(SwaggerExtensionsConstants.SwaggerOptionsConfiguration).Bind(swaggerOptions);

// Add  Authentication
builder.Services
.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddMicrosoftIdentityWebApi(builder.Configuration.GetSection("AzureAd"));

// ... Other configurations

// Register the 'automatic' Swagger generator configurations.
builder.Services.AddCustomSwaggerGenerator(swaggerOptions);

// ... Other configurations

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseCustomSwagger(swaggerOptions);
}

// ... Other configurations

Custom OAuth2 With 'Authorization Code' Flow

Program.cs

// Register the Add Custom OAuth2 With Authorization Code Flow configurations.
builder.Services.AddCustomOAuth2WithAuthorizationCodeFlowSwaggerGenerator(swaggerOptions);

Custom OAuth2 With 'Client Credentials' Flow

Program.cs

// Register the Custom OAuth2 With Client Credentials Flow configurations.
builder.Services.AddCustomOAuth2WithClientCredentialsFlowSwaggerGenerator(swaggerOptions);

Custom OAuth2 With 'Implicit' Flow

Program.cs

// Register the Custom OAuth2 With Implicit Flow configurations.
builder.Services.AddCustomOAuth2WithImplicitFlowSwaggerGenerator(swaggerOptions);

Custom OAuth2 With 'Client Credentials' Flow

Program.cs

// Register the Custom OAuth2 With Client Credentials Flow configurations.
builder.Services.AddCustomOAuth2WithClientCredentialsFlowSwaggerGenerator(swaggerOptions);

Add Custom OAuth2 With 'Password' Flow Swagger Generator

Program.cs

// Register the Custom OAuth2 With Password Flow configurations.
builder.Services.AddCustomOAuth2WithPasswordFlowSwaggerGenerator(swaggerOptions);

Add Custom 'ApiKey

Program.cs

SwaggerExtensionsOptions swaggerOptions = new SwaggerExtensionsOptions();
builder.Configuration.GetSection(SwaggerExtensionsConstants.SwaggerOptionsConfiguration).Bind(swaggerOptions);
var apiKey = swaggerOptions.ApiKeyHeaderToken;
var apikeyHeader = swaggerOptions.ApiKeyHeader;

// ... Other configurations

builder.Services.AddSingleton(new SimpleApiKeyAuthenticationSchemeOptions { ApiKey = apiKey });
builder.Services.AddAuthentication(apikeyHeader)
    .AddScheme<SimpleApiKeyAuthenticationSchemeOptions, SimpleApiKeyAuthenticationHandler>(
        apikeyHeader,
        opts => opts.ApiKey = apiKey
    );

// Register the 'automatic' Swagger generator configurations.
builder.Services.AddCustomApiKeySwaggerGenerator(swaggerOptions);

Contributors

• @masterzdran

Attribution

Api icons created by Smashicons - Flaticon