0.0.1 • Published 4 years ago

spaceapi-validator-client v0.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
4 years ago

spaceapi-validator-client

SpaceapiValidatorClient - JavaScript client for spaceapi-validator-client This is the SpaceApi Validator api This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • Build package: org.openapitools.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 spaceapi-validator-client --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 spaceapi-validator-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install spaceapi-community/spaceapi-validator-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, 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 SpaceapiValidatorClient = require('spaceapi-validator-client');


var api = new SpaceapiValidatorClient.V1Api()
api.v1Get().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://validator.spaceapi.io

ClassMethodHTTP requestDescription
SpaceapiValidatorClient.V1Apiv1GetGET /v1
SpaceapiValidatorClient.V1Apiv1ValidatePostPOST /v1/validate/validate an input against the SpaceApi schema
SpaceapiValidatorClient.V2Apiv2GetGET /v2
SpaceapiValidatorClient.V2Apiv2ValidateJSONPostPOST /v2/validateJSONvalidate an input against the SpaceApi schema
SpaceapiValidatorClient.V2Apiv2ValidateURLPostPOST /v2/validateURLvalidate an input against the SpaceApi schema

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

0.0.1

4 years ago