https://github.com/n-smir/shadow-api-net
ShadowApiNet is a tool that allows seamless generation of RESTful CRUD APIs in your ASP.NET Core app.
https://github.com/n-smir/shadow-api-net
asp-net-core csharp csharp-library net-core
Last synced: 6 months ago
JSON representation
ShadowApiNet is a tool that allows seamless generation of RESTful CRUD APIs in your ASP.NET Core app.
- Host: GitHub
- URL: https://github.com/n-smir/shadow-api-net
- Owner: n-smir
- Created: 2019-12-27T17:05:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T01:14:57.000Z (over 2 years ago)
- Last Synced: 2025-10-06T01:59:50.486Z (9 months ago)
- Topics: asp-net-core, csharp, csharp-library, net-core
- Language: C#
- Homepage:
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShadowApiNet
[](https://www.nuget.org/packages/ShadowApiNet/)
[](https://github.com/n-smir/shadow-api-net/actions?query=workflow%3A%22Build+%26+test%22)
#### Warning - the project is still in POC stage, so it might not feature a full functionality yet, functionality and usage might change as well.
ShadowApiNet is a tool that allows seamless generation of RESTful API in your ASP.NET Core app.
ShadowApiNet can generate RESTful API based on DbContext that you provide (hence you should manage DB connection yourself).
And expose your SQL Database in a form of fully REST compliant API.
### Installation
Using dotnet CLI:
```sh
dotnet add package ShadowApiNet
```
use ```--version``` to install spesific version.
Or using PackageManager Console:
```ps
PM> Install-Package ShadowApiNet
```
use ```-Version``` to install spesific version.
### Usage
The following section demonstrates how you can plug in and use ShadowApiNet in your ASP.Net Core application.
First create your DbContext: (example from official [EF Core docs](https://docs.microsoft.com/en-us/ef/core/get-started/?tabs=netcore-cli))
``` cs
public class BloggingContext : DbContext
{
public DbSet Blogs { get; set; }
public DbSet Posts { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder options)
=> options.UseSqlite("Data Source=blogging.db");
}
public class Blog
{
[Key]
public int BlogId { get; set; }
public string Url { get; set; }
public List Posts { get; } = new List();
}
public class Post
{
[Key]
public int PostId { get; set; }
public string Title { get; set; }
public string Content { get; set; }
public int BlogId { get; set; }
public Blog Blog { get; set; }
}
```
And then in your `Startup.cs` add the following lines:
``` cs
using ShadowApiNet.Extensions;
...
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddDbContext(ServiceLifetime.Singleton);
services.AddShadowApi(new BloggingContext());
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseShadowApi();
}
}
```
Now, when you start your application you'll be able to access generated API using `/dataapi` path.
For example:
``` sh
curl http://localhost:5000/dataapi/blogs
```
will return all the Blogs that are in the database.
And:
``` sh
curl http://localhost:5000/dataapi/blogs/1
```
will return Blog with Id 1 or `404 Not Found` if Blog with such id does not exist.
In repository you will find a test project that shows how the library can be used.
Please be aware that generated API will expose your DB models to the API consumers. (In later versions it may support Automapper configuration)