magic.library 17.3.9

dotnet add package magic.library --version 17.3.9                
NuGet\Install-Package magic.library -Version 17.3.9                
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="magic.library" Version="17.3.9" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add magic.library --version 17.3.9                
#r "nuget: magic.library, 17.3.9"                
#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 magic.library as a Cake Addin
#addin nuget:?package=magic.library&version=17.3.9

// Install magic.library as a Cake Tool
#tool nuget:?package=magic.library&version=17.3.9                

magic.library - Tying Magic together

This project helps you to wire up everything related to Magic. Normally you'd use it simply like the following from your startup class in your .Net 8 Web API project.

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using magic.library;

namespace magic.backend
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            // Initializing Magic.
            services.AddMagic(Configuration);
        }

        public void Configure(IApplicationBuilder app)
        {
            // Initializing Magic.
            app.UseMagic(Configuration);
        }
    }
}

However, you can also take more control over how things are actually wired up, by instead of using the "do all methods" called AddMagic and UseMagic, invoke some of the specialized initialization methods, you can find below.

  • IServiceCollection.AddMagicCaching
  • IServiceCollection.AddMagicHttp
  • IServiceCollection.AddMagicLogging
  • IServiceCollection.AddMagicSignals
  • IServiceCollection.AddMagicExceptions
  • IServiceCollection.AddMagicEndpoints
  • IServiceCollection.AddMagicAuthorization
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicConfiguration
  • IServiceCollection.AddMagicScheduler
  • IServiceCollection.AddMagicMail
  • IServiceCollection.AddMagicLambda
  • IServiceCollection.AddMagicSockets

The above methods is basically what the AddMagic method actually does, and they're extension methods of IServiceCollection, that can be found in the magic.library namespace. Similar alternatives to UseMagic can be found below.

  • IApplicationBuilder.UseMagicExceptions
  • IApplicationBuilder.UseMagicStartupFiles
  • IApplicationBuilder.UseMagicScheduler
  • IApplicationBuilder.UseMagicCors

If you use these methods instead of the "do all methods", your motivation would probably be to replace one of these methods with your own implementation, to exchange the default wiring, by (for instance) using a "virtual database based file system" by creating your own service implementation of for instance IFileService from "magic.lambda.io", or use a different logging provider than the default, etc. If you wish to do this, you'd probably benefit from looking at what the default implementation of your method does, to understand the requirements from your method. Doing this is very powerful, and allows you to change the way the system behaves by default - But is also definitely considered an "advanced exercise".

Exceptions handlers

Magic allows you to provide a custom exceptions handler on a per folder level. This overrides the default exception logic with a custom exception handler expected to be named "exceptions.hl" and found within the folder hierarchy where an HTTP invocation is resolved. For instance, if you wish to create your own exception handler for a specific module called "foo", you can create an exception handler file called "/files/modules/foo/exceptions.hl", and expect this file to be invoked every time an unhandled exception occurs, anywhere inside of your "foo" folder. This allows you to transform an unhandled exception, such as for instance localising it or customising it in any ways. Your custom exception handler will be invoked with the following arguments.

  • [message] - The exception error message
  • [path] - The URL that triggered the exception
  • [field] - If the exception that was thrown declared a field, this argument will contain the name of the field
  • [status] - If the exception that was thrown declared a status code, this argument will contain the status code
  • [public] - If the exception that was thrown wants to propagate to the client this will be true

You can return a "transformed" exception from your exception handler, returning the following arguments, that will end up becoming the response object returned to the client.

  • [message] - Message to return as JSON to client
  • [field] - Field to return as JSON to client
  • [status] - Status code to decorate your HTTP response with

The default exception handler can be found in "/files/exceptions.hl", which will be invoked if no custom exception handler is declared further down in your folder hierarchy.

Magic's GitHub project page

Magic is 100% Open Source and you can find the primary project GitHub page here.

Project website for magic.lambda.library

The source code for this repository can be found at github.com/polterguy/magic.library, and you can provide feedback, provide bug reports, etc at the same place.

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities

The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
17.3.9 229 2/17/2024
17.3.7 143 2/12/2024
17.3.6 113 2/12/2024
17.3.5 103 2/10/2024
17.3.4 102 2/9/2024
17.3.3 105 2/8/2024
17.3.2 115 2/2/2024
17.3.1 120 1/30/2024
17.2.2 92 1/30/2024
17.2.1 131 1/22/2024
17.2.0 104 1/22/2024
17.1.7 175 1/12/2024
17.1.6 142 1/11/2024
17.1.5 150 1/5/2024
17.0.1 201 1/1/2024
17.0.0 335 12/14/2023
16.11.6 228 11/14/2023
16.11.5 178 11/12/2023
16.9.0 296 10/9/2023
16.8.5 178 9/30/2023
16.8.4 171 9/25/2023
16.8.0 143 9/24/2023
16.7.51 135 9/24/2023
16.7.50 149 9/23/2023
16.7.1 193 9/4/2023
16.7.0 304 7/11/2023
16.6.13 192 7/6/2023
16.6.12 191 7/5/2023
16.6.11 177 7/5/2023
16.6.5 215 7/3/2023
16.4.4 215 7/2/2023
16.4.3 224 6/27/2023
16.4.2 216 6/25/2023
16.4.1 216 6/25/2023
16.4.0 202 6/22/2023
16.3.2 295 6/7/2023
16.3.0 303 5/28/2023
16.2.0 383 5/13/2023
16.1.10 361 5/1/2023
16.1.9 282 4/30/2023
16.1.1 303 4/20/2023
15.10.11 325 4/16/2023
15.9.40 358 4/3/2023
15.9.1 414 3/27/2023
15.9.0 417 3/24/2023
15.8.2 457 3/20/2023
15.7.0 339 3/6/2023
15.5.20 707 2/23/2023
15.5.13 508 2/13/2023
15.5.9 401 2/11/2023
15.5.2 484 2/5/2023
15.5.1 398 2/3/2023
15.5.0 473 1/28/2023
15.2.0 617 1/18/2023
15.1.0 1,085 12/28/2022
14.5.7 625 12/13/2022
14.5.5 726 12/6/2022
14.5.1 560 11/23/2022
14.5.0 506 11/18/2022
14.4.5 582 10/22/2022
14.4.2 510 10/22/2022
14.4.1 515 10/22/2022
14.4.0 548 10/17/2022
14.3.9 568 10/13/2022
14.3.6 571 10/7/2022
14.3.2 580 9/18/2022
14.3.1 660 9/12/2022
14.3.0 553 9/10/2022
14.1.3 815 8/7/2022
14.1.2 565 8/7/2022
14.1.1 573 8/7/2022
14.0.14 559 7/26/2022
14.0.12 555 7/24/2022
14.0.11 525 7/23/2022
14.0.10 550 7/23/2022
14.0.9 533 7/23/2022
14.0.8 621 7/17/2022
14.0.5 689 7/11/2022
14.0.4 623 7/7/2022
14.0.3 615 7/2/2022
14.0.2 560 7/2/2022
14.0.1 605 7/2/2022
14.0.0 585 6/25/2022
13.4.28 577 6/11/2022
13.4.25 689 6/9/2022
13.4.24 579 6/9/2022
13.4.19 631 6/8/2022
13.4.3 607 6/6/2022
13.4.2 638 6/4/2022
13.4.0 664 5/31/2022
13.3.8 638 5/19/2022
13.3.7 597 5/18/2022
13.3.6 640 5/14/2022
13.3.4 714 5/9/2022
13.3.1 649 5/1/2022
13.3.0 609 5/1/2022
13.2.2 665 4/25/2022
13.2.1 622 4/25/2022
13.2.0 651 4/21/2022
13.1.1 670 4/20/2022
13.1.0 745 4/7/2022
13.0.0 681 4/5/2022
12.0.3 844 3/14/2022
11.0.7 721 3/11/2022
11.0.5 775 3/2/2022
11.0.4 696 2/22/2022
11.0.3 697 2/9/2022
11.0.2 752 2/6/2022
11.0.1 744 2/5/2022
10.0.21 710 1/28/2022
10.0.20 728 1/27/2022
10.0.19 710 1/23/2022
10.0.18 679 1/17/2022
10.0.17 692 1/14/2022
10.0.16 544 1/2/2022
10.0.15 601 12/31/2021
10.0.14 613 12/28/2021
10.0.13 683 12/23/2021
10.0.11 474 12/23/2021
10.0.10 493 12/22/2021
10.0.9 651 12/22/2021
10.0.8 538 12/22/2021
10.0.7 694 12/22/2021
10.0.6 577 12/19/2021
10.0.5 672 12/18/2021
10.0.3 456 12/16/2021
10.0.2 535 12/14/2021
10.0.1 427 12/13/2021
10.0.0 472 12/6/2021
9.9.9 1,258 11/29/2021
9.9.6 4,721 11/24/2021
9.9.5 476 11/23/2021
9.9.4 774 11/21/2021
9.9.3 545 11/9/2021
9.9.2 563 11/4/2021
9.9.0 663 10/30/2021
9.8.9 684 10/29/2021
9.8.7 572 10/27/2021
9.8.6 580 10/27/2021
9.8.5 672 10/26/2021
9.8.4 645 10/25/2021
9.8.3 698 10/24/2021
9.8.1 569 10/21/2021
9.8.0 644 10/20/2021
9.7.9 558 10/20/2021
9.7.8 591 10/19/2021
9.7.7 825 10/17/2021
9.7.6 721 10/17/2021
9.7.5 596 10/14/2021
9.7.1 534 10/14/2021
9.7.0 610 10/9/2021
9.6.8 620 8/30/2021
9.6.7 597 8/26/2021
9.6.6 709 8/14/2021
9.6.5 813 8/11/2021
9.6.4 608 8/10/2021
9.6.3 598 8/9/2021
9.6.2 591 8/8/2021
9.6.1 555 8/8/2021
9.5.9 752 8/5/2021
9.5.8 748 8/4/2021
9.5.3 633 7/20/2021
9.5.0 993 7/9/2021
9.4.5 608 6/29/2021
9.4.4 756 6/29/2021
9.4.0 599 6/24/2021
9.3.7 607 6/21/2021
9.3.6 659 6/21/2021
9.3.5 787 6/18/2021
9.3.4 717 6/18/2021
9.2.5 766 6/7/2021
9.2.4 704 6/6/2021
9.2.3 640 6/6/2021
9.2.2 549 6/4/2021
9.2.1 784 6/1/2021
9.2.0 742 5/26/2021
9.1.9 557 5/5/2021
9.1.8 704 5/5/2021
9.1.7 567 5/3/2021
9.1.4 576 4/21/2021
9.1.2 562 4/18/2021
9.1.1 547 4/15/2021
9.1.0 601 4/14/2021
9.0.1 667 4/12/2021
9.0.0 564 4/5/2021
8.9.92 1,137 3/30/2021
8.9.4 1,149 3/26/2021
8.9.3 1,191 3/19/2021
8.9.2 1,172 1/29/2021
8.9.1 1,237 1/24/2021
8.9.0 1,303 1/22/2021
8.7.1 1,606 11/15/2020
8.7.0 1,309 11/15/2020
8.6.9 1,246 11/8/2020
8.6.7 1,218 11/4/2020
8.6.6 1,303 11/2/2020
8.6.5 1,283 11/1/2020
8.6.3 1,298 10/30/2020
8.6.2 1,208 10/30/2020
8.6.1 1,299 10/29/2020
8.6.0 1,258 10/28/2020
8.5.1 1,248 10/26/2020
8.5.0 1,197 10/23/2020
8.4.6 1,416 10/20/2020
8.4.5 1,293 10/18/2020
8.4.4 1,320 10/17/2020
8.4.3 1,287 10/16/2020
8.4.2 1,236 10/16/2020
8.4.1 1,234 10/15/2020
8.4.0 1,311 10/13/2020
8.3.3 1,235 10/11/2020
8.3.2 1,278 10/8/2020
8.3.1 1,295 10/5/2020
8.3.0 1,247 10/3/2020
8.2.3 1,204 10/1/2020
8.2.2 1,484 9/26/2020
8.2.1 1,344 9/25/2020
8.2.0 1,378 9/25/2020
8.1.25 1,274 9/24/2020
8.1.24 1,267 9/23/2020
8.1.23 1,195 9/23/2020
8.1.22 1,266 9/21/2020
8.1.21 1,319 9/15/2020
8.1.20 1,328 9/14/2020
8.1.19 1,305 9/13/2020
8.1.18 1,273 9/13/2020
8.1.17 1,323 9/13/2020
8.1.16 1,322 9/13/2020
8.1.15 1,247 9/12/2020
8.1.13 1,142 9/11/2020
8.1.12 1,266 9/11/2020
8.1.11 1,269 9/11/2020
8.1.10 1,314 9/6/2020
8.1.9 1,312 9/3/2020
8.1.8 1,336 9/2/2020
8.1.7 1,204 8/28/2020
8.1.4 1,205 8/25/2020
8.1.3 1,378 8/18/2020
8.1.2 1,195 8/16/2020
8.1.1 1,257 8/15/2020
8.0.3 1,271 8/11/2020
8.0.2 1,293 8/7/2020
8.0.1 1,296 8/7/2020
8.0.0 1,241 8/7/2020
7.0.1 1,351 6/28/2020
7.0.0 1,343 6/28/2020
5.0.10 1,306 5/31/2020
5.0.9 1,411 5/30/2020
5.0.8 1,289 5/29/2020
5.0.7 1,256 5/29/2020
5.0.5 1,348 2/27/2020
5.0.4 1,317 2/26/2020
5.0.3 1,308 2/26/2020
5.0.2 1,314 2/25/2020
5.0.1 1,215 2/25/2020
5.0.0 1,335 2/25/2020
4.1.5 1,276 2/23/2020
4.1.4 1,359 2/23/2020
4.1.3 1,292 2/22/2020
4.1.2 1,285 2/22/2020
4.1.1 1,279 2/21/2020
4.1.0 1,310 2/21/2020
4.0.9 1,398 2/7/2020
4.0.8 1,234 2/7/2020
4.0.7 1,255 2/7/2020
4.0.5 1,268 1/28/2020
4.0.4 1,400 1/27/2020
4.0.3 1,254 1/27/2020
4.0.2 1,395 1/16/2020
4.0.1 1,419 1/11/2020
4.0.0 1,366 1/5/2020
3.1.7 1,416 12/17/2019
3.1.6 1,307 12/12/2019
3.1.5 1,303 12/12/2019
3.1.4 1,317 12/5/2019
3.1.3 1,350 12/4/2019
3.1.2 1,375 11/30/2019
3.1.1 1,534 11/26/2019
3.1.0 1,336 11/10/2019
3.0.4 1,177 11/1/2019
3.0.3 1,343 10/28/2019
3.0.2 1,355 10/28/2019
3.0.1 1,346 10/26/2019
3.0.0 1,176 10/23/2019
2.1.4 967 10/21/2019
2.1.3 1,309 10/21/2019
2.1.2 1,440 10/21/2019
2.1.1 1,315 10/19/2019
2.1.0 1,365 10/19/2019
2.0.9 1,062 10/18/2019
2.0.8 1,330 10/18/2019
2.0.7 1,069 10/18/2019
2.0.6 1,057 10/18/2019
2.0.5 1,108 10/18/2019
2.0.4 1,073 10/17/2019
2.0.3 1,204 10/16/2019
2.0.2 1,190 10/15/2019
2.0.1 1,233 10/14/2019
2.0.0 1,067 10/13/2019
1.1.7 1,399 10/11/2019
1.1.6 1,347 10/11/2019