RESTworld.EntityFrameworkCore
1.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package RESTworld.EntityFrameworkCore --version 1.1.0
NuGet\Install-Package RESTworld.EntityFrameworkCore -Version 1.1.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="RESTworld.EntityFrameworkCore" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RESTworld.EntityFrameworkCore --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: RESTworld.EntityFrameworkCore, 1.1.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 RESTworld.EntityFrameworkCore as a Cake Addin
#addin nuget:?package=RESTworld.EntityFrameworkCore&version=1.1.0
// Install RESTworld.EntityFrameworkCore as a Cake Tool
#tool nuget:?package=RESTworld.EntityFrameworkCore&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
RESTworld
RESTworld is a framework which utilizes other common frameworks and patterns alltogether to enable easy and fast creation of a truly RESTful API.
Used frameworks and patterns
- Entity Framework Core for data access
- ASP.Net Core for hosting
- HAL for providing hyperlinks between resources
- OData for query support on list endpoints
- AutoMapper for mapping between Entities and DTOs
- Resource based authorization
- API Versioning through media types
Pipeline
The most basic pipeline has the following data flow for a request on a list endpoint:
- Request
- Controller selection through ASP.Net Core (optionally with versioning)
- Query parsing through OData
- Controller method calls business service method
- Authorization validates and modifies the request (both optional)
- Service validates that all migrations have been applied to the database, to protect from locks during migration.
- Service gets the data through Entity Framework Core
- Entity Framework Core translates the query into SQL and gets the data from the database
- Business service translates Entities into DTOs through Automapper
- Authorization validates and modifies the response (both optional)
- Controller wraps the result in a HAL response
- Result
Usage as API developer
Example
You can find a complete example which leverages all the features offered by RESTworld at https://github.com/wertzui/RESTworld/tree/main/src/Example/ExampleBlog.
Solution structure
If your API gets the name MyApi, structure your Solution with the following Projects:
- MyApi (ASP.Net Core Web API)
- References RESTworld.AspNetCore, MyApi.Business
- Contains your startup logic and your custom controllers
- MyApi.Business
- References RESTworld.Business, MyApi.Data
- Contains your AutoMapperConfiguration and your custom services
- MyApi.Data
- References RESTworld.EntityFrameworkCore, MyApi.Common
- Contains your Entity Framework Core Database Model including Entities and Migrations
- MyApi.Common
- References RESTworld.Common
- Contains your DTOs and Enums
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. 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.
-
net5.0
- Microsoft.EntityFrameworkCore.SqlServer (>= 5.0.9)
- RESTworld.Common (>= 1.1.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on RESTworld.EntityFrameworkCore:
| Package | Downloads |
|---|---|
|
RESTworld.Business
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated |
|---|---|---|
| 7.1.1 | 502 | 1/9/2024 |
| 7.1.0 | 163 | 12/22/2023 |
| 7.0.0 | 606 | 11/15/2023 |
| 6.1.0 | 307 | 10/23/2023 |
| 6.0.0 | 296 | 9/27/2023 |
| 5.3.2 | 234 | 9/11/2023 |
| 5.3.1 | 421 | 7/17/2023 |
| 5.3.0 | 248 | 7/3/2023 |
| 5.2.3 | 205 | 6/28/2023 |
| 5.2.2 | 859 | 6/14/2023 |
| 5.2.1 | 378 | 5/25/2023 |
| 5.2.0 | 357 | 4/30/2023 |
| 5.1.3 | 237 | 4/19/2023 |
| 5.1.2 | 283 | 3/12/2023 |
| 5.1.1 | 597 | 2/22/2023 |
| 5.1.0 | 317 | 2/9/2023 |
| 5.0.0 | 494 | 1/24/2023 |
| 4.0.1 | 720 | 12/21/2022 |
| 4.0.0 | 1,053 | 11/9/2022 |
| 3.4.2 | 893 | 10/20/2022 |
| 3.4.1 | 811 | 10/20/2022 |
| 3.4.0 | 937 | 9/27/2022 |
| 3.2.3 | 1,195 | 6/28/2022 |
| 3.2.2 | 1,777 | 6/8/2022 |
| 3.2.1 | 1,312 | 5/13/2022 |
| 3.2.0 | 1,155 | 4/1/2022 |
| 3.1.0 | 876 | 3/30/2022 |
| 3.0.2 | 1,731 | 3/10/2022 |
| 3.0.1 | 1,226 | 3/9/2022 |
| 3.0.0 | 3,127 | 2/21/2022 |
| 2.0.2 | 815 | 1/14/2022 |
| 2.0.1 | 434 | 1/6/2022 |
| 2.0.0 | 830 | 12/3/2021 |
| 1.3.1 | 977 | 11/4/2021 |
| 1.3.0 | 1,859 | 9/29/2021 |
| 1.2.0 | 588 | 9/27/2021 |
| 1.1.0 | 1,020 | 8/18/2021 |
| 1.0.3 | 835 | 6/29/2021 |
| 1.0.2 | 511 | 5/11/2021 |
| 1.0.1 | 535 | 4/22/2021 |
| 1.0.0 | 852 | 3/31/2021 |