spaceapi-validator-client-es6

@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: 1.0.0
• Package version: 1.0.0
• 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

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your @spaceapi/validator-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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

Class	Method	HTTP request	Description
spaceapiValidatorClient.V1Api	v1Get	GET /v1
spaceapiValidatorClient.V1Api	v1ValidatePost	POST /v1/validate/	validate an input against the SpaceApi schema
spaceapiValidatorClient.V2Api	v2Get	GET /v2
spaceapiValidatorClient.V2Api	v2ValidateJSONPost	POST /v2/validateJSON	validate an input against the SpaceApi schema
spaceapiValidatorClient.V2Api	v2ValidateURLPost	POST /v2/validateURL	validate an input against the SpaceApi schema

Documentation for Models

• spaceapiValidatorClient.ServerInformation
• spaceapiValidatorClient.ValidateJsonV2Response
• spaceapiValidatorClient.ValidateUrlV2
• spaceapiValidatorClient.ValidateUrlV2Response
• spaceapiValidatorClient.ValidateV1
• spaceapiValidatorClient.ValidateV1Response

Documentation for Authorization

All endpoints do not require authorization.