👁 Image
TCDev.APIGenerator 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

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