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

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 30000 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | petstoreAuthCredentials | PetstoreAuthCredentials | The credential object for petstoreAuth | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey |

The API client can be initialized as follows:

Code-Based Client Initialization

import {
  Client,
  Environment,
  LogLevel,
  OauthScopePetstoreAuth,
} from 'matic-cli';

const client = new Client({
  petstoreAuthCredentials: {
    oauthClientId: 'OAuthClientId',
    oauthRedirectUri: 'OAuthRedirectUri',
    oauthScopes: [
      OauthScopePetstoreAuth.Writepets,
      OauthScopePetstoreAuth.Readpets
    ]
  },
  apiKeyCredentials: {
    'api_key': 'api_key'
  },
  timeout: 30000,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'matic-cli';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'matic-cli';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

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

Fields

| Name | Description | | --- | --- | | Production | Default |

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

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError