Kodice.RapidAPI 2.0.6

Kodice.RapidAPI

Kodice.RapidAPI has been designed to promote the reuse of common and repetitive code required for authorizing and handling RapidAPI calls to your functions.

About the Project

As an example, if we want to use a new API with .NET Core on a Cloud service of our choice and integrate it with RapidAPI, there are certain steps that we must follow.

• Validate the Secret Key sent via RapidAPI request headers.
• Check if the Customer performing the request has the right to request a specific feature.

Usually these steps are quite tedious, repetitive, and prone to error.

Getting Started

Installing Kodice.RapidAPI

dotnet add package Kodice.RapidAPI

Project status

Environment	Status
Development
Production

Usage

Minimal API

Minimal APIs are a simplified approach for building fast HTTP APIs with ASP.NET Core. You can build fully functioning REST endpoints with minimal code and configuration.

A simple example on how to add the Kodice.RapidAPI to your API project.

using Kodice.RapidAPI.Minimal;
using Kodice.RapidAPI.Models;
using Kodice.RapidAPI.Constsants;

app.MapGet("/minimal/test-01", () =>
{
    return "test-01";
})
    .AddRapidAPI(Plans.FromConfiguration(app.Configuration, "RapidAPI"));

app.MapGet("/minimal/test-02", () =>
{
    return "test-02";
})
    .AddRapidAPI(app.Configuration, "RapidAPI");

var grpA = app
    .MapGroup("/minimal/group-01")
    .AddRapidAPI(Plans.FromConfiguration(app.Configuration, "RapidAPI"));
grpA.MapGet("/test-01", () => { return "group-01"; });

var grpB = app
    .MapGroup("/minimal/group-02")
    .AddRapidAPI(app.Configuration, "RapidAPI");
grpB.MapGet("/test-01", () => { return "group-02"; });

app.Run();

Web API

ASP.NET Core supports creating web APIs using controllers or using minimal APIs. Controllers in a web API are classes that derive from ControllerBase. Controllers are activated and disposed on a per request basis.

A simple example on how to add the Kodice.RapidAPI to your API project. The attribute load settings from the application setting file starting from default JSON section "RapidAPI". You can define your own or multiple sections, and pass the string to the attribute.

using Kodice.RapidAPI.Models;
using Kodice.RapidAPI.WebAPI;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
[RapidAPIAuthorization()]
public class WeatherForecastController : ControllerBase
{
    [HttpGet(Name = "GetWeatherForecast")]
    public IEnumerable<WeatherForecast> Get()
    { ... }
}

Also possible to add to single Method:

using Kodice.RapidAPI.Models;
using Kodice.RapidAPI.WebAPI;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [HttpGet(Name = "GetWeatherForecast")]
    [RapidAPIAuthorization("MY-CUSTOM-SECTION")]
    public IEnumerable<WeatherForecast> Get()
    { ... }
}

JSON Settings

The subscription object can be defined in code for Minimal API, and loaded from configuration for Web Api. The following is an example of application settings that include a Custom Subscription as well. The RapidAPI Secret is a mandatory property.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "RapidAPI": {
    "Secret": "YOUR-SECRET-HERE",
    "Basic": [
      "feature-01",
      "feature-02"
    ],
    "Pro": [
      "feature-01",
      "feature-02",
      "feature-03",
      "feature-04"
    ],
    "Mega": [
      "feature-01",
      "feature-02",
      "feature-03",
      "feature-04",
      "feature-05",
      "feature-06"

    ],
    "Ultra": [
      "feature-01",
      "feature-02",
      "feature-03",
      "feature-04",
      "feature-05",
      "feature-06",
      "feature-07",
      "feature-08"
    ],
    "Others": {
      "CUSTOM-PRIVATE": [ "extra-feat-01", "extra-feat-02" ]
    }
  }
}

Support and Sponsor

Please consider supporting the development with a little help, just a coffee