npm.io
1.0.0 • Published 9 years ago

swagger-js-client

Licence
Apache-2.0
Version
1.0.0
Deps
1
Vulns
1
Weekly
0
DeprecatedThis package is deprecated

swagger-js-client

SwaggerJsClient - JavaScript client for swagger-js-client 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: 0.1.TJ.SAMPLE
  • Package version: 0.1.TJ.SAMPLE
  • Build package: class 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 swagger-js-client --save
git

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

    npm install YOUR_USERNAME/swagger-js-client --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AddressesApi()

var id = 56; // {Number} 


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

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/PRO2025EE/api/v1

Class Method HTTP request Description
SwaggerJsClient.AddressesApi callDelete DELETE /addresses/{id} Delete an existing address with specified id
SwaggerJsClient.AddressesApi createAddress POST /addresses Create a new address
SwaggerJsClient.AddressesApi getOne GET /addresses/{id} Show contact by id.
SwaggerJsClient.AddressesApi updateAddress PUT /addresses/{id} Update an existing address with specified id
SwaggerJsClient.ContactsApi callDelete DELETE /contacts/{Id} Delete an existing contact with specified id
SwaggerJsClient.ContactsApi createContact POST /contacts Create a new contact
SwaggerJsClient.ContactsApi getAddresses GET /contacts/{id}/addresses Get addresses for a specified contact
SwaggerJsClient.ContactsApi getAllContacts GET /contacts Show all.
SwaggerJsClient.ContactsApi getOne GET /contacts/{id} Show contact by id.
SwaggerJsClient.ContactsApi updateBranch PUT /contacts/{id} Update an existing contact with specified id
SwaggerJsClient.DefaultApi hello GET /Info Show the API name.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.