ServiceProviderEndpoint 1.1.0
dotnet add package ServiceProviderEndpoint --version 1.1.0
NuGet\Install-Package ServiceProviderEndpoint -Version 1.1.0
<PackageReference Include="ServiceProviderEndpoint" Version="1.1.0" />
paket add ServiceProviderEndpoint --version 1.1.0
#r "nuget: ServiceProviderEndpoint, 1.1.0"
// Install ServiceProviderEndpoint as a Cake Addin #addin nuget:?package=ServiceProviderEndpoint&version=1.1.0 // Install ServiceProviderEndpoint as a Cake Tool #tool nuget:?package=ServiceProviderEndpoint&version=1.1.0
ServiceProviderEndpoint
IServiceProvider webapi endpoint for faster and easier development.
Usage
If you have already registered services in the collection and want to give access to them via http, then just map a universal endpoint like this:
app.MapServiceProvider("services", builder.Services);
app.Run();
Now you can send post/get requests to your services, like:
GET /services/IYourService/SomeMethod?args=["arg1","arg2","arg3"]
or
POST /services/IYourService/SomeMethod
Content-Type: application/json
["arg1","arg2","arg3"]
Generics
Example request with generics:
GET /services/IYourService/SomeGenericMethod(Int32)?args=[111,222,333]
Requests use URL-safe notation for types. For example, Dictionary(String-Array(Int32)) is equivalent of Dictionary<string,int[]>.
Type casting
If your method has object type arguments like:
Task<int> ExampleMethod(object data, CancellationToken cancellationToken);
Then you need to add the type for cast as an additional parameter to the request:
GET /services/IYourService/ExampleMethod/List(String)?args=[["list_item1","list_item2","list_item3"]]
File streams
For downloading, it is enough that the method returns a stream object:
Task<Stream> SomeDownloadMethod(string a, string b, string c, CancellationToken cancellationToken);
Download request will be like this:
GET /services/IYourService/SomeDownloadMethod?args=["argA","argB","argC"]
For uploading, the method must have an argument of type Stream (position doesn't matter):
Task SomeUploadMethod(Stream stream, string a, string b, string c, CancellationToken cancellationToken);
Upload request:
POST /services/IYourService/SomeUploadMethod?args=["argA","argB","argC"]
Content-Type: application/octet-stream
<SomeFileData>
JavaScript example:
let file = document.getElementById('some-input').files[0];
let response = await fetch('/services/IYourService/SomeUploadMethod?args='+encodeURIComponent(JSON.stringify(["argA","argB","argC"])), {
method: 'POST',
headers: { 'content-type': file.type || 'application/octet-stream' },
body: file,
});
Security
If you don't want to publish all services in the collection, then just add a filter:
app.MapServiceProvider("services", builder.Services
.Where(x => x.ServiceType.Namespace.StartsWith("Example")));
If authorization is needed, then it is added by the standard method for IEndpointConventionBuilder:
app.MapServiceProvider("services", builder.Services)
.RequireAuthorization();
Security for methods can be added via Scrutor-decorators:
builder.Services.AddScoped<IExampleService, ExampleService>();
builder.Services.Decorate<IExampleService, SecureExampleService>();
.NET client
To connect to api from another .net application, use an existing client:
using ServiceProviderEndpoint.Client;
using var client = new SpeClient("https://localhost:7149/services");
var result = await client
.GetService<IYourService>()
.SomeMethod("arg1","arg2","arg3");
Example projects
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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 is compatible. 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 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. |
-
net6.0
- MetaFile.Http.AspNetCore (>= 1.1.0)
- TypeSerialization.Json (>= 1.1.0)
-
net7.0
- MetaFile.Http.AspNetCore (>= 1.1.0)
- TypeSerialization.Json (>= 1.1.0)
-
net8.0
- MetaFile.Http.AspNetCore (>= 1.1.0)
- TypeSerialization.Json (>= 1.1.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ServiceProviderEndpoint:
Package | Downloads |
---|---|
EntityDynamicAttributes.WebApi
WebApi endpoint extension of EntityDynamicAttributes |
GitHub repositories
This package is not used by any popular GitHub repositories.