EasyCoreAPI 1.1.14

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package EasyCoreAPI --version 1.1.14                

                    
                

            
NuGet\Install-Package EasyCoreAPI -Version 1.1.14
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="EasyCoreAPI" Version="1.1.14" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add EasyCoreAPI --version 1.1.14                

                    
                

            
#r "nuget: EasyCoreAPI, 1.1.14"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install EasyCoreAPI as a Cake Addin
#addin nuget:?package=EasyCoreAPI&version=1.1.14

// Install EasyCoreAPI as a Cake Tool
#tool nuget:?package=EasyCoreAPI&version=1.1.14

EasyCoreAPI

Overview

The EasyCoreAPI SDK simplifies the setup of Swagger documentation, API versioning, and controller configurations in ASP.NET Core applications. It provides a seamless way to integrate modern API practices with minimal effort.

Installation

  1. Add the EasyCoreAPI SDK to your project using NuGet:
dotnet add package EasyCoreAPI
  1. Include the namespace in your Program.cs or Startup.cs file:
using EasyCoreAPI;

Features.

  • Enable annotations for better documentation.
  • Configure API versioning with Swagger UI.
  • Configure security definitions for APIs with token-based authentication.
  • Automatically resolves XML comments from project files.

Usage

Requirements

  • .NET 6.0 or later
  • Compatible with ASP.NET Core applications.

Add SwaggerGen

services.AddAPISwaggerGen(Configuration, AuthScheme.Bearer);

Add API Versioning

services.AddAPIVersioning(1);

Add API Controllers

services.AddAPIControllers();

Use SwaggerUI in WebApplication

app.UseAPISwaggerUI();

Update PropertyGroup of .csproj file

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

Add ApiDocsConfig to appsettings.json file

{
  "ApiDocsConfig": {
    "ShowSwaggerUi": true,
    "ShowRedocUi": false,
    "EnableSwaggerTryIt": true
  }
}

Contributing

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Commit your changes.
  5. Push your changes to your fork.
  6. Submit a pull request.

License

This project is licensed under the MIT License.

Support

For any questions or issues, please open an issue on GitHub or contact us at <a href="mailto:developer.biliksuun@gmail.com"> developer.biliksuun@gmail.com</a>.

Authors

  • Samuel Biliksuun
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.14 64 1/5/2025
1.1.13 80 1/5/2025
1.1.12 74 1/5/2025
1.1.11 73 1/5/2025
1.1.1 94 1/3/2025
1.1.0 93 1/3/2025
1.0.0 93 1/3/2025

Version 1.1.14 - Initial Release