openapi-generator/samples/client/petstore/csharp-dotnet2/OpenAPIClientTest/Lib/OpenAPIClient

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.CSharpDotNet2ClientCodegen

Frameworks supported

• .NET 2.0

Dependencies

• Mono compiler
• Newtonsoft.Json.7.0.1
• RestSharp.Net2.1.1.11

Note: NuGet is downloaded by the mono compilation script and packages are installed with it. No dependency DLLs are bundled with this generator

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh compile-mono.sh
• [Windows] TODO

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

Getting Started

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

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

            try
            {
                // Add a new pet to the store
                apiInstance.AddPet(pet);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.AddPet: " + e.Message );
            }
        }
    }
}

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

• Org.OpenAPITools.Model.ApiResponse
• Org.OpenAPITools.Model.Category
• Org.OpenAPITools.Model.Order
• Org.OpenAPITools.Model.Pet
• Org.OpenAPITools.Model.Tag
• Org.OpenAPITools.Model.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