npm package: @spaceapi/validator-client
Description: This_is_the_SpaceApi_Validator_api
Latest version: 1.2.1

# @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](https://openapi-generator.tech) project:

- API version: 1.2.0
- Package version: 1.2.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @spaceapi/validator-client --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install spaceapi-community/spaceapi-validator-client --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/V1Api.md#v1Get) | **GET** /v1 | 
*spaceapiValidatorClient.V1Api* | [**v1ValidatePost**](docs/V1Api.md#v1ValidatePost) | **POST** /v1/validate/ | validate an input against the SpaceApi schema
*spaceapiValidatorClient.V2Api* | [**v2Get**](docs/V2Api.md#v2Get) | **GET** /v2 | 
*spaceapiValidatorClient.V2Api* | [**v2ValidateJSONPost**](docs/V2Api.md#v2ValidateJSONPost) | **POST** /v2/validateJSON | validate an input against the SpaceApi schema
*spaceapiValidatorClient.V2Api* | [**v2ValidateURLPost**](docs/V2Api.md#v2ValidateURLPost) | **POST** /v2/validateURL | validate an input against the SpaceApi schema


## Documentation for Models

 - [spaceapiValidatorClient.SchemaError](docs/SchemaError.md)
 - [spaceapiValidatorClient.ServerInformation](docs/ServerInformation.md)
 - [spaceapiValidatorClient.ValidateJsonV2Response](docs/ValidateJsonV2Response.md)
 - [spaceapiValidatorClient.ValidateUrlV2](docs/ValidateUrlV2.md)
 - [spaceapiValidatorClient.ValidateUrlV2Response](docs/ValidateUrlV2Response.md)
 - [spaceapiValidatorClient.ValidateV1](docs/ValidateV1.md)
 - [spaceapiValidatorClient.ValidateV1Response](docs/ValidateV1Response.md)


## Documentation for Authorization

All endpoints do not require authorization.