LinkPaymentsSDK 10.0.0

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.

Some useful links:

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

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

Install the Package

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

dotnet add package LinkPaymentsSDK --version 10.0.0

You can also view the package at: https://www.nuget.org/packages/LinkPaymentsSDK/10.0.0

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:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using SwaggerPetstoreOpenApi30.Standard;
using SwaggerPetstoreOpenApi30.Standard.Authentication;
using SwaggerPetstoreOpenApi30.Standard.Models;
using System.Collections.Generic;

namespace ConsoleApp;

SwaggerPetstoreOpenApi30Client client = new SwaggerPetstoreOpenApi30Client.Builder()
    .PetstoreAuthCredentials(
        new PetstoreAuthModel.Builder(
            "OAuthClientId",
            "OAuthRedirectUri"
        )
        .OauthScopes(
            new List<OauthScopePetstoreAuth>
            {
                OauthScopePetstoreAuth.Writepets,
                OauthScopePetstoreAuth.Readpets,
            })
        .Build())
    .ApiKeyCredentials(
        new ApiKeyModel.Builder(
            "api_key"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(SwaggerPetstoreOpenApi30.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using SwaggerPetstoreOpenApi30.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = SwaggerPetstoreOpenApi30Client
    .FromConfiguration(configuration.GetSection("SwaggerPetstoreOpenApi30"));

See the Configuration-Based Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• petstore_auth (OAuth 2 Implicit Grant)
• api_key (Custom Header Signature)

List of APIs

• Pet
• Store
• User

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter