https://github.com/polterguy/magic.library
Helper project to wire up Magic
https://github.com/polterguy/magic.library
Last synced: 26 days ago
JSON representation
Helper project to wire up Magic
- Host: GitHub
- URL: https://github.com/polterguy/magic.library
- Owner: polterguy
- License: gpl-3.0
- Created: 2019-10-06T11:26:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T05:18:00.000Z (over 2 years ago)
- Last Synced: 2025-12-11T13:26:06.907Z (7 months ago)
- Language: C#
- Homepage: https://ainiro.io
- Size: 368 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```csharp
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](https://github.com/polterguy/magic).
## Project website for magic.lambda.library
The source code for this repository can be found at [github.com/polterguy/magic.library](https://github.com/polterguy/magic.library), and you can provide feedback, provide bug reports, etc at the same place.
- 
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
- [](https://sonarcloud.io/dashboard?id=polterguy_magic.library)
## Copyright and maintenance
The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by [AINIRO.IO](https://ainiro.io).