TCDev.APIGenerator 0.7.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package TCDev.APIGenerator --version 0.7.0                

                    
                

            
NuGet\Install-Package TCDev.APIGenerator -Version 0.7.0
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="TCDev.APIGenerator" Version="0.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add TCDev.APIGenerator --version 0.7.0                

                    
                

            
#r "nuget: TCDev.APIGenerator, 0.7.0"
#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 TCDev.APIGenerator as a Cake Addin
#addin nuget:?package=TCDev.APIGenerator&version=0.7.0

// Install TCDev.APIGenerator as a Cake Tool
#tool nuget:?package=TCDev.APIGenerator&version=0.7.0

image Getting Started | Samples | Walkthrough Video

Get fully working CRUD API's in an instant!

<a href="https://docs.rasepi.com"><img src="https://img.shields.io/badge/Docs-0.6.0-orange"></a> <a href="https://twitter.com/intent/follow?screen_name=timcadenbach"><img src="https://img.shields.io/badge/Twitter-follow-blue"></a> <a href="https://www.github.com/sponsors/deejaytc"><img src="https://img.shields.io/github/sponsors/deejaytc?label=Lovely%20Sponsors" /> </a>

Build & Nuget Status

Version Build Nuget
Main <img src="https://img.shields.io/github/workflow/status/DeeJayTC/net-dynamic-api/.NET/main?label=Main"> 0.6.0 Build Status Installer pipeline
VNext <img src="https://img.shields.io/github/workflow/status/DeeJayTC/net-dynamic-api/.NET/vnext?label=vnext"> 0.6.1-RC1

About

The API Generator automatically generates a fully working CRUD Microservice from just your Model (C# Classes) or a JSON Definition. Everything from routes, database handling, migrations, openapi spec, OData etc is working magically out of the box! You just write your model and get a fully working CRUD api with filtering, sorting, selectable fields and everything else OData and classic REST offers.

By using the API Generator, this little code snippet is already a working CRUD API

/// <summary>
/// This is the minimal sample, yes this is a working api ;)
/// </summary>
[Api("/minimal")]
public class MinimalSample : IObjectBase<int>
{
  public int Id { get; set; }
  public string Name { get; set; }
  public int Value { get; set; }
}

Heres another sample:

 [Api("/people", ApiMethodsToGenerate.All )]
 public class Person : Trackable, 
    IObjectBase<Guid>,
    IBeforeUpdate<Person>, // Before Update Hook
    IBeforeDelete<Person>, // BeforeDelete Hook
 {
    public string Name { get; set; }
    public DateTime Date { get; set; }
    public string Description { get; set; }
    public int Age { get; set; }
    public Guid Id { get; set; }
 }

And this is also the FULL code for a working API using the JSON mode:

[
    {
      "name": "Car",
      "route": "/cars",
      "caching": true,
      "cacheLiveTime": 1000,
      "events": "POST,PUT,DELETE",
      "idType":  "int", 
      "Fields": [
        {
          "name": "Name",
          "type": "String",
          "maxLength": "200",
          "nullable": false
        }
      ]
    }
  ]

Getting Started & Docoumentation

Read this for a more detailed guide → https://www.tcdev.de/tcdev-api-generator-getting-started Or just follow these steps:

  • Install the package
dotnet add package TCDev.ApiGenerator --prerelease

after the package is installed add this to your program.cs (or startup.cs)

// Add API Generator and load data
builder.Services.AddApiGeneratorServices()
                //From Assembly with OData .AddAssemblyWithOData(Assembly.GetExecutingAssembly())
                //or as JSON from Uri .AddAssemblyWithODataFromUri("https://raw.githubusercontent.com/DeeJayTC/net-dynamic-api/main/sample/SampleAppJson/ApiDefinition.json","")
                //Or without OData .AddAssembly(Assembly.GetExecutingAssembly())
                .AddDataContextSQL() // or Postgres or SQLite
                .AddOData()
                .AddSwagger(true);

Documentation → https://docs.rasepi.com/

Samples

You can find samples for using the library in the samples repository, constantly updated to match latest version and features:

https://github.com/DeeJayTC/api-generator-samples

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on TCDev.APIGenerator:

Package Downloads
TCDev.APIGenerator.OData

Adds OData Support to the API Generator
TCDev.APIGenerator.Data.SQL

Adds necessary functionality to use MS SQL Server and Azure SQL Instances with the API Generator.
TCDev.APIGenerator.Data.SQLite

Adds necessary functionality to use SQLLite with the API Generator. Rasepi greates fully working CRUD Apis from just models
TCDev.APIGenerator.Data.Postgres

Adds necessary functionality to use Postgres databases with the API Generator. Rasepi greates fully working CRUD Apis from just models
TCDev.APIGenerator.RabbitMQ

Package adds RabbitMQ events to the APIs. Creates fully working CRUD Apis from just models

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.7.1-RC1 629 10/16/2022
0.7.0 1,322 11/8/2022
0.7.0-RC1 665 7/25/2022
0.6.0 1,425 6/24/2022
0.6.0-RC2 715 6/24/2022
0.6.0-RC1 588 6/24/2022
0.5.0-WeAreDevs 575 6/12/2022
0.5.0-WDWC-DEMO-ODATA 562 6/12/2022
0.5.0-WDWC-DEMO 619 6/11/2022
0.5.0-WDWC 598 6/11/2022
0.5.0-alpha-1 635 6/10/2022
0.1.5 848 5/6/2022
0.1.4 823 4/16/2022
0.1.3 787 4/16/2022
0.1.2 794 4/15/2022
0.1.2-alpha-6ffff 564 4/16/2022
0.1.2-alpha-4a262d 520 4/16/2022
0.1.1-alpha 521 3/29/2022
0.1.0-alpha-4a262d 537 4/8/2022
0.1.0-alpha-3f152c 571 4/7/2022
0.1.0-alpha 584 3/29/2022
0.0.9-alpha 559 3/29/2022
0.0.8-alpha 558 3/29/2022
0.0.7-alpha 541 3/26/2022
0.0.6-alpha 553 3/26/2022
0.0.5-alpha 604 3/26/2022
0.0.4-alpha 556 3/25/2022