RESTworld.Common 1.2.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package RESTworld.Common --version 1.2.0                

                    
                

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

                    
                

            
#r "nuget: RESTworld.Common, 1.2.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.Common as a Cake Addin
#addin nuget:?package=RESTworld.Common&version=1.2.0

// Install RESTworld.Common as a Cake Tool
#tool nuget:?package=RESTworld.Common&version=1.2.0

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:

  1. Request
  2. Controller selection through ASP.Net Core (optionally with versioning)
  3. Query parsing through OData
  4. Controller method calls business service method
  5. Authorization validates and modifies the request (both optional)
  6. Service validates that all migrations have been applied to the database, to protect from locks during migration.
  7. Service gets the data through Entity Framework Core
  8. Entity Framework Core translates the query into SQL and gets the data from the database
  9. Business service translates Entities into DTOs through Automapper
  10. Authorization validates and modifies the response (both optional)
  11. Controller wraps the result in a HAL response
  12. 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 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net5.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on RESTworld.Common:

Package Downloads
RESTworld.EntityFrameworkCore

Package Description
RESTworld.Client.Net

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
10.0.0 131 11/20/2024
9.1.1 558 10/11/2024
9.1.0 230 9/27/2024
9.0.0 577 7/3/2024
8.0.0 230 6/4/2024
7.2.0 837 1/9/2024
7.1.0 232 12/22/2023
7.0.0 803 11/15/2023
6.1.0 371 10/23/2023
6.0.0 399 9/27/2023
5.3.0 790 7/3/2023
5.2.2 1,154 6/14/2023
5.2.1 485 5/25/2023
5.2.0 564 4/30/2023
5.1.2 528 3/12/2023
5.1.1 731 2/22/2023
5.1.0 423 2/9/2023
5.0.0 606 1/24/2023
4.0.1 856 12/21/2022
4.0.0 1,193 11/9/2022
3.4.1 1,710 10/20/2022
3.4.0 1,236 9/27/2022
3.3.1 3,249 6/8/2022
3.3.0 589 6/7/2022
3.2.0 2,333 4/1/2022
3.1.0 1,066 3/30/2022
3.0.0 5,643 2/21/2022
2.0.0 1,719 12/3/2021
1.3.0 2,862 11/25/2021
1.2.1 1,125 11/4/2021
1.2.0 2,053 9/29/2021
1.1.0 1,535 8/18/2021
1.0.1 1,593 4/22/2021
1.0.0 1,017 3/31/2021