forked from loafle/openapi-generator-original
7c67f731bc
* rename csharp-netcore to csharp * rename file * renmae modules/openapi-generator/src/main/resources/csharp-netcore * update samples * mv dir * update samples * rename csharp-netcore to csharp in appveyor.yml * update doc
124 lines
4.3 KiB
Markdown
124 lines
4.3 KiB
Markdown
# Org.OpenAPITools - the C# library for the MultipartFile test
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 1.0.0
|
|
- SDK version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
|
|
|
|
<a id="frameworks-supported"></a>
|
|
## Frameworks supported
|
|
- .NET Core >=1.0
|
|
- .NET Framework >=4.6
|
|
- Mono/Xamarin >=vNext
|
|
|
|
<a id="dependencies"></a>
|
|
## Dependencies
|
|
|
|
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
|
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later
|
|
- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later
|
|
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
|
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later
|
|
|
|
The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
|
|
```
|
|
Install-Package RestSharp
|
|
Install-Package Newtonsoft.Json
|
|
Install-Package JsonSubTypes
|
|
Install-Package System.ComponentModel.Annotations
|
|
Install-Package CompareNETObjects
|
|
```
|
|
|
|
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742).
|
|
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
|
|
|
<a id="installation"></a>
|
|
## Installation
|
|
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
|
|
|
Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:
|
|
```csharp
|
|
using Org.OpenAPITools.Api;
|
|
using Org.OpenAPITools.Client;
|
|
using Org.OpenAPITools.Model;
|
|
```
|
|
<a id="usage"></a>
|
|
## Usage
|
|
|
|
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
|
```csharp
|
|
Configuration c = new Configuration();
|
|
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
|
|
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
|
c.Proxy = webProxy;
|
|
```
|
|
|
|
<a id="getting-started"></a>
|
|
## Getting Started
|
|
|
|
```csharp
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
using Org.OpenAPITools.Api;
|
|
using Org.OpenAPITools.Client;
|
|
using Org.OpenAPITools.Model;
|
|
|
|
namespace Example
|
|
{
|
|
public class Example
|
|
{
|
|
public static void Main()
|
|
{
|
|
|
|
Configuration config = new Configuration();
|
|
config.BasePath = "http://localhost";
|
|
var apiInstance = new MultipartApi(config);
|
|
var files = new List<System.IO.Stream>(); // List<System.IO.Stream> | Many files (optional)
|
|
|
|
try
|
|
{
|
|
apiInstance.MultipartArray(files);
|
|
}
|
|
catch (ApiException e)
|
|
{
|
|
Debug.Print("Exception when calling MultipartApi.MultipartArray: " + e.Message );
|
|
Debug.Print("Status Code: "+ e.ErrorCode);
|
|
Debug.Print(e.StackTrace);
|
|
}
|
|
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
<a id="documentation-for-api-endpoints"></a>
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*MultipartApi* | [**MultipartArray**](docs/MultipartApi.md#multipartarray) | **POST** /multipart-array |
|
|
*MultipartApi* | [**MultipartMixed**](docs/MultipartApi.md#multipartmixed) | **POST** /multipart-mixed |
|
|
*MultipartApi* | [**MultipartSingle**](docs/MultipartApi.md#multipartsingle) | **POST** /multipart-single |
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
- [Model.MultipartArrayRequest](docs/MultipartArrayRequest.md)
|
|
- [Model.MultipartMixedRequest](docs/MultipartMixedRequest.md)
|
|
- [Model.MultipartMixedRequestMarker](docs/MultipartMixedRequestMarker.md)
|
|
- [Model.MultipartMixedStatus](docs/MultipartMixedStatus.md)
|
|
- [Model.MultipartSingleRequest](docs/MultipartSingleRequest.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
Endpoints do not require authorization.
|
|
|