openapi-generator/samples/client/petstore/csharp-functions/generatedSrc

Org.OpenAPITools - the C# library for the OpenAPI Petstore

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpFunctionsServerCodegen

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencies

• RestSharp - 106.11.7 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#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.

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:

using Org.OpenAPITools.Apis;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Models;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Apis;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Models;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://petstore.swagger.io/v2";
            // Configure OAuth2 access token for authorization: petstore_auth
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi(config);
            var pet = new Pet(); // Pet | Pet object that needs to be added to the store

            try
            {
                // Add a new pet to the store
                Pet result = apiInstance.AddPet(pet);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling PetApi.AddPet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
PetApi	AddPet	POST /pet	Add a new pet to the store
PetApi	DeletePet	DELETE /pet/{petId}	Deletes a pet
PetApi	FindPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetApi	FindPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetApi	GetPetById	GET /pet/{petId}	Find pet by ID
PetApi	UpdatePet	PUT /pet	Update an existing pet
PetApi	UpdatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	UploadFile	POST /pet/{petId}/uploadImage	uploads an image
StoreApi	DeleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreApi	GetInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	GetOrderById	GET /store/order/{orderId}	Find purchase order by ID
StoreApi	PlaceOrder	POST /store/order	Place an order for a pet
UserApi	CreateUser	POST /user	Create user
UserApi	CreateUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserApi	CreateUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserApi	DeleteUser	DELETE /user/{username}	Delete user
UserApi	GetUserByName	GET /user/{username}	Get user by user name
UserApi	LoginUser	GET /user/login	Logs user into the system
UserApi	LogoutUser	GET /user/logout	Logs out current logged in user session
UserApi	UpdateUser	PUT /user/{username}	Updated user

Documentation for Models

• Models.ApiResponse
• Models.Category
• Models.Order
• Models.Pet
• Models.Tag
• Models.User

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets