openapi-generator

the C# library for the Swagger Petstore

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose.

This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version:
Build date: 2016-04-14T08:34:43.608-04:00
Build package: class io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

.NET 4.0 or later
Windows Phone 7.1 (Mango)

Dependencies

[RestSharp] (https://www.nuget.org/packages/RestSharp) - 105.1.0 or later
[Json.NET] (https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

[Mac/Linux] compile-mono.sh
[Windows] compile.bat

Then include the DLL (under the bin folder) in the C# project

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Module;

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 body = new Pet(); // Pet | Pet object that needs to be added to the store

            try {
            apiInstance.AddPet(body);
            } 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

Documentation for Authorization

petstore_auth

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

api_key

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