Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DigDes/SoapCore
SOAP extension for ASP.NET Core
https://github.com/DigDes/SoapCore
middleware soap
Last synced: 2 months ago
JSON representation
SOAP extension for ASP.NET Core
- Host: GitHub
- URL: https://github.com/DigDes/SoapCore
- Owner: DigDes
- License: mit
- Created: 2016-12-27T00:39:44.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-05T17:56:26.000Z (3 months ago)
- Last Synced: 2024-11-13T10:29:19.825Z (3 months ago)
- Topics: middleware, soap
- Language: C#
- Size: 1.75 MB
- Stars: 1,006
- Watchers: 35
- Forks: 378
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-Nuget-Packages - **SoapCore**
README
# SoapCore
[](https://www.nuget.org/packages/SoapCore/)  [](https://stackoverflow.com/questions/tagged/soapcore)
SOAP protocol middleware for ASP.NET Core
Based on Microsoft article: [Custom ASP.NET Core Middleware Example](https://blogs.msdn.microsoft.com/dotnet/2016/09/19/custom-asp-net-core-middleware-example/).
Support ref\out params, exceptions. Works with legacy SOAP\WCF-clients.
## Getting Started
### Requirements
The following frameworks are supported:
- .NET 5.0-7.0 (using ASP.NET Core 5.0-7.0)
- .NET Core 3.1 (using ASP.NET Core 3.1)
- .NET Standard 2.0-2.1 (using ASP.NET Core 2.1)
### Installing
`PM> Install-Package SoapCore`
There are 2 different ways of adding SoapCore to your ASP.NET Core website. If you are using ASP.NET Core 3.1 or higher with endpoint routing enabled (the default):
In Startup.cs:
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddSoapCore();
services.TryAddSingleton();
services.AddMvc();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
app.UseRouting();
app.UseEndpoints(endpoints => {
endpoints.UseSoapEndpoint(opt =>
{
opt.Path = "/ServicePath.asmx",
opt.SoapSerializer = SoapSerializer.DataContractSerializer
});
});
}
```
If you are using ASP.NET Core 2.1 (i.e., on .NET Framework, .NET Core 2.1, or another .NET Standard 2.0 compliant platform):
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddSoapCore();
services.TryAddSingleton();
services.AddMvc();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
app.UseSoapEndpoint("/ServicePath.asmx", new SoapEncoderOptions());
}
```
### Using with custom implementation of Serialization
There is an optional feature included where you can implment the ISoapCoreSerializer to built your own custom serializar for body.
In Startup.cs:
```csharp
public void ConfigureServices(IServiceCollection services)
{
...
services.AddSoapCore();
services.TryAddSingleton();
services.AddCustomSoapMessageSerializer(); //Add Your Custom Implementation or Extend Default Serializer
services.AddMvc();
...
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
app.UseSoapEndpoint(soapCoreOptions =>
{
soapCoreOptions.Path = "/ServicePath.asmx";
soapCoreOptions.UseCustomSerializer(); //Specify the Service to Use Service Soap Message Serializer
soapCoreOptions.SoapSerializer = SoapSerializer.DataContractSerializer;
...
});
}
```
### Using with legacy WCF/WS
It is possible to use SoapCore with .NET legacy WCF and Web Services, both as client and service.
Primary point here is to use XmlSerializer and properly markup messages and operations with xml serialization attributes. You may use legacy pre-generated wrappers to obtain these contracts or implement them manually. Extended example is available under serialization tests project.
### Using with external WSDL / XSD schemas
There is an optional feature included where you can instead of generating service description from code get the service description from files stored on the server.
To use it, add a setting like this to appsettings
```json
"FileWSDL": {
"UrlOverride": "",
"SchemeOverride": "",
"VirtualPath": "",
"WebServiceWSDLMapping": {
"Service.asmx": {
"UrlOverride": "Management/Service.asmx",
"WsdlFile": "snapshotpull.wsdl",
"SchemaFolder": "Schemas",
"WsdlFolder": "Schemas"
}
}
}
```
* UrlOverride - can be used to override the URL in the service description. This can be useful if you are behind a firewall.
* SchemeOverride - can be used to override the HTTP Scheme in the service description. This can be useful if you are behind a firewall and the firewall sets the X-Forwarded-Host header, but the internal HTTP scheme is not the same as the external.
* VirtualPath - can be used if you like to add a path between the base URL and service.
* WebServiceWSDLMapping
* UrlOverride - can be used to override the URL for a specific WSDL mapping. This can be useful if you want to host different services under different folder.
* Service.asmx - is the endpoint of the service you expose. You can have more than one.
* WsdlFile - is the name of the WSDL on disc.
* SchemaFolder - if you import XSD from WSDL, this is the folder where the Schemas are stored on disc.
* WsdlFolder - is the folder that the WSDL file is stored on disc.
To read the setting you can do the following
In Startup.cs:
```csharp
var settings = Configuration.GetSection("FileWSDL").Get();
// For case-insensitive mapping, if you are using "SoapCoreOptions.CaseInsensitivePath = true" - otherwise URLs with different casing won't be mapped correctly
//var settings = Configuration.GetSection("FileWSDL").Get();
settings.AppPath = env.ContentRootPath; // The hosting environment root path
...
app.UseSoapEndpoint("/Service.asmx", new SoapEncoderOptions(), SoapSerializer.XmlSerializer, false, null, settings);
```
If the WsdFileOptions parameter is supplied then this feature is enabled / used.
### References
- [stackify.com/soap-net-core](https://stackify.com/soap-net-core/)
### Tips and Tricks
#### Extending the pipeline
In your ConfigureServices method, you can register some additional items to extend the pipeline:
- services.AddSoapMessageInspector() - add a custom MessageInspector. This function is similar to the `IDispatchMessageInspector` in WCF. The newer `IMessageInspector2` interface allows you to register multiple inspectors, and to know which service was being called.
- services.AddSingleton() - add a custom OperationInvoker. Similar to WCF's `IOperationInvoker` this allows you to override the invoking of a service operation, commonly to add custom logging or exception handling logic around it.
- services.AddSoapMessageProcessor() - add a custom SoapMessageProcessor. Similar to ASP.NET Cores middlewares, this allows you to inspect the message on the way in and out. You can also short-circuit the message processing and return your own custom message instead. Inspecting and modifying HttpContext is also possible
#### Using ISoapMessageProcessor()
```csharp
//Add this to ConfigureServices in Startup.cs
services.AddSoapMessageProcessor(async (message, httpcontext, next) =>
{
var bufferedMessage = message.CreateBufferedCopy(int.MaxValue);
var msg = bufferedMessage.CreateMessage();
var reader = msg.GetReaderAtBodyContents();
var content = reader.ReadInnerXml();
//now you can inspect and modify the content at will.
//if you want to pass on the original message, use bufferedMessage.CreateMessage(); otherwise use one of the overloads of Message.CreateMessage() to create a new message
var originalMessage = bufferedMessage.CreateMessage();
//pass the modified message on to the rest of the pipe.
var responseMessage = await next(message);
//Inspect and modify the contents of returnMessage in the same way as the incoming message.
//finish by returning the modified message.
return responseMessage;
});
```
#### How to get custom HTTP header in SoapCore service
Use interface IServiceOperationTuner to tune each operation call.
Create class that implements IServiceOperationTuner.
Parameters in Tune method:
- httpContext - current HttpContext. Can be used to get http headers or body.
- serviceInstance - instance of your service.
- operation - information about called operation.
```csharp
public class MyServiceOperationTuner : IServiceOperationTuner
{
public void Tune(HttpContext httpContext, object serviceInstance, SoapCore.ServiceModel.OperationDescription operation)
{
if (operation.Name.Equals("SomeOperationName"))
{
MyService service = serviceInstance as MyService;
string result = string.Empty;
StringValues paramValue;
if (httpContext.Request.Headers.TryGetValue("some_parameter", out paramValue))
{
result = paramValue[0];
}
service.SetParameterForSomeOperation(result);
}
}
}
```
Register MyServiceOperationTuner in Startup class:
```csharp
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// ...
services.AddSoapServiceOperationTuner(new MyServiceOperationTuner());
//...
}
// ...
}
```
Change your service to get the possibility to store information from http headers:
```csharp
public class MyService : IMyServiceService
{
// Use ThreadLocal or some of thread synchronization stuff if service registered as singleton.
private ThreadLocal _paramValue = new ThreadLocal() { Value = string.Empty };
// ...
public void SetParameterForSomeOperation(string paramValue)
{
_paramValue.Value = paramValue;
}
public string SomeOperationName()
{
return "Param value from http header: " + _paramValue.Value;
}
}
```
#### Additional namespace declaration attributes in envelope
Adding additional namespaces to the **SOAP Envelope** can be done by populating `SoapEncoderOptions.AdditionalEnvelopeXmlnsAttributes` parameter.
```csharp
....
endpoints.UseSoapEndpoint(opt =>
{
opt.Path = "/ServiceWithAdditionalEnvelopeXmlnsAttributes.asmx";
opt.AdditionalEnvelopeXmlnsAttributes = new Dictionary()
{
{ "myNS", "http://schemas.someting.org" },
{ "arr", "http://schemas.microsoft.com/2003/10/Serialization/Arrays" }
};
});
...
```
This code will put `xmlns:myNS="...` and `xmlns:arr="...` attributes in `Envelope` and message will look like:
```xml
...
Error: one
Error: two
...
```
instead of:
```xml
...
Error: one
Error: two
...
```
### Not implemented
WCF and legacy WebService supports many scenarios and lots of attributes. SoapCore only supports the most common patterns.
Stuff that are not supported includes:
* XmlIncludeAttribute/SoapIncludeAttribute
* SoapDocumentMethodAttribute
*
### Contributing
See [Contributing guide](CONTRIBUTING.md)
### Contributors
Made with [contributors-img](https://contributors-img.web.app).