restaurant-api-sdk

Getting Started with QR-Based Restaurant Management System API

Introduction

Updated API documentation for QR-Based Restaurant Management System

Install the Package

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

npm install restaurant-api-sdk@1.0.1

For additional package details, see the Npm page for the restaurant-api-sdk@1.0.1 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
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

The API client can be initialized as follows:

import { Client, LogLevel } from 'restaurant-api-sdk';

const client = new Client({
  timeout: 30000,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

List of APIs

• Menu
• Order

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError