SwaggerPetstoreOpenApi3_0 TypeScript SDK 1.0.0

Welcome to the SwaggerPetstoreOpenApi3_0 SDK documentation. This guide will help you get started with integrating and using the SwaggerPetstoreOpenApi3_0 SDK in your project.

This SDK was generated by Postman

Versions

• SDK version: 1.0.0

About the API

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

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm or yarn:

npm install swagger-petstore-openapi-3.0

or

yarn add swagger-petstore-openapi-3.0

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const swaggerPetstoreOpenApi3_0 = new SwaggerPetstoreOpenApi3_0({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { SwaggerPetstoreOpenApi3_0 } from 'swagger-petstore-openapi-3.0';

(async () => {
  const swaggerPetstoreOpenApi3_0 = new SwaggerPetstoreOpenApi3_0({});

  const data = await swaggerPetstoreOpenApi3_0.store.getInventory();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :----------------------------------------------------- | | PetService | | StoreService | | UserService |

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

| Name | Description | | :----------------------------------------------------------------------- | :---------- | | Pet | | | Category | | | Tag | | | FindPetsByStatusStatus | | | ApiResponse | | | Order | | | User | |