SwaggerPetstore3SDK 1.0.1

Getting Started with Swagger Petstore - OpenAPI 3.0

Introduction

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at https://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

If you're looking for the Swagger 2.0/OAS 2.0 version of Petstore, then click here. Alternatively, you can load via the Edit > Load Petstore OAS 2.0 menu option!

Some useful links:

• The Pet Store repository
• The source API definition for the Pet Store

Find out more about Swagger: http://swagger.io

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package SwaggerPetstore3SDK --version 1.0.1

You can also view the package at: https://www.nuget.org/packages/SwaggerPetstore3SDK/1.0.1

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

SwaggerPetstoreOpenAPI30.Standard.SwaggerPetstoreOpenAPI30Client client = new SwaggerPetstoreOpenAPI30.Standard.SwaggerPetstoreOpenAPI30Client.Builder()
    .CustomHeaderAuthenticationCredentials("api_key")
    .Build();

Authorization

This API uses Custom Header Signature.

List of APIs

• Pet
• Store
• User

Classes Documentation

• Utility Classes
• HttpRequest
• HttpResponse
• HttpStringResponse
• HttpContext
• HttpClientConfiguration
• HttpClientConfiguration Builder
• IAuthManager
• ApiException