swagger-js

api_v1

ApiV1 - JavaScript client for api_v1 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.0.0
• Package version: v1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

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

Then install it via:

npm install api_v1 --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 api_v1 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('api_v1') 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/api_v1 then install it via:

    npm install YOUR_USERNAME/api_v1 --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 ApiV1 = require('api_v1');

var api = new ApiV1.BooksApi()

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

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class	Method	HTTP request	Description
ApiV1.BooksApi	apiV1BooksGet	GET /api/v1/books	Get all books
ApiV1.BooksApi	apiV1BooksIdDelete	DELETE /api/v1/books/{id}	delete a book
ApiV1.BooksApi	apiV1BooksIdGet	GET /api/v1/books/{id}	fetch a book
ApiV1.BooksApi	apiV1BooksIdPut	PUT /api/v1/books/{id}	update a book
ApiV1.BooksApi	apiV1BooksPost	POST /api/v1/books	Creates a book
ApiV1.BooksApi	apiV1BooksSearchBookssearchQuerysearchQueryGet	GET /api/v1/books/search_books?search_query={search_query}	search a book

Documentation for Models

• ApiV1.Book
• ApiV1.Book1

Documentation for Authorization

All endpoints do not require authorization.