GuiStracini.SDKBuilder

:construction: :gear: A SDK framework that helps create a .NET SDK project for API wrappers/clients

Project maintained by guibranco Hosted on GitHub Pages — Theme by mattgraham

GuiStracini.SDKBuilder

An SDK framework that helps create a C# SDK project for consuming a generic REST API

GitHub license Time tracker

GuiStracini.SDKBuilder logo

CI/CD

Build status Last commit Tests Coverage Code Smells LoC
Build status GitHub last commit AppVeyor tests (branch) Coverage Code Smells Lines of Code

Code Quality

DeepSource

Codacy Badge Codacy Badge

codecov CodeFactor

Maintainability Test Coverage

Quality Gate Status Maintainability Rating

Technical Debt Duplicated Lines (%)

Reliability Rating Security Rating

Bugs Vulnerabilities

DeepSource

Installation

Github Releases

GitHub last release Github All Releases

Download the latest zip file from the Release page.

Nuget package manager

Package Version Downloads
GuiStracini.SDKBuilder GuiStracini.SDKBuilder NuGet Version GuiStracini.SDKBuilder NuGet Downloads

This package allows the easy creation of an SDK (Sofware Development Kit) for consuming a REST API based on WebAPI2 conventions. The ServiceFactory class implements the IServiceFactory interface, having the methods Get, Post, Put, Delete, Head, and Upload. It uses self-convention and custom attributes to generate smart endpoints and perform requests.

Creating a new SDK

To create a new SDK, you must first acquire the API endpoints, the object (in-out) properties, and the authorization flow.

Currently, this package only supports basic authorization (via HTTP headers or JWT-like). OAuth/OAuth2 is not supported by default but can be implemented by yourself or in a future version. Let me know—via PR—if you make some progress on that!).