Skip to content

Cox Automotive/KBB Coding Exercise: Retrieve Data from an API

Notifications You must be signed in to change notification settings

AnikaArora/javascript-client

Repository files navigation

dealers_and_vehicles

DealersAndVehicles - JavaScript client for dealers_and_vehicles No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dealers_and_vehicles --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your dealers_and_vehicles from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('dealers_and_vehicles') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/dealers_and_vehicles then install it via:

    npm install YOUR_USERNAME/dealers_and_vehicles --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var DealersAndVehicles = require('dealers_and_vehicles');

var api = new DealersAndVehicles.ClientApi()

var language = "language_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generate(language, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
DealersAndVehicles.ClientApi generate GET /client/{language}
DealersAndVehicles.ClientApi index GET /client
DealersAndVehicles.DataSetApi getCheat GET /api/{datasetId}/cheat Get correct answer for dataset (cheat)
DealersAndVehicles.DataSetApi getDataSetId GET /api/datasetId Creates new dataset and returns its ID
DealersAndVehicles.DataSetApi postAnswer POST /api/{datasetId}/answer Submit answer for dataset
DealersAndVehicles.DealersApi getDealer GET /api/{datasetId}/dealers/{dealerid} Get information about a dealer
DealersAndVehicles.VehiclesApi getIds GET /api/{datasetId}/vehicles Get a list of all vehicleids in dataset
DealersAndVehicles.VehiclesApi getVehicle GET /api/{datasetId}/vehicles/{vehicleid} Get information about a vehicle

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

Cox Automotive/KBB Coding Exercise: Retrieve Data from an API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published