TCDev.APIGenerator.Schema 0.6.0

.NET 6.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package TCDev.APIGenerator.Schema --version 0.6.0
NuGet\Install-Package TCDev.APIGenerator.Schema -Version 0.6.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.Schema" Version="0.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TCDev.APIGenerator.Schema --version 0.6.0
#r "nuget: TCDev.APIGenerator.Schema, 0.6.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install TCDev.APIGenerator.Schema as a Cake Addin
#addin nuget:?package=TCDev.APIGenerator.Schema&version=0.6.0

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

image Getting Started | Samples | Walkthrough Video

Turn your models into fully working APIs in minutes

<a href="https://tcdev.gitbook.io/"><img src="https://img.shields.io/badge/Docs-0.0.9-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.1.3 Build Status Installer pipeline
VNext <img src="https://img.shields.io/github/workflow/status/DeeJayTC/net-dynamic-api/.NET/vnext?label=vnext"> 0.1.2-alpha-6ffff

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(builder.Configuration, Assembly.GetExecutingAssembly());

Documentation → https://tcdev.gitbook.io/

Samples

https://github.com/DeeJayTC/net-dynamic-api/tree/main/sample

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

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

Package Downloads
TCDev.APIGenerator

Creates fully working CRUD Apis from just models

TCDev.APIGenerator.Data

Package Description

TCDev.APIGenerator.RabbitMQ

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

TCDev.APIGenerator.Redis

Adds necessary functionality to use Redis Cache with the API Generator. Rasepi greates 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 36 10/16/2022
0.7.0-RC1 70 7/25/2022
0.6.0 470 6/24/2022
0.6.0-RC2 94 6/24/2022
0.6.0-RC1 72 6/24/2022