1.0.0 • Published 11 months ago

@sporting.services/dicts v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
11 months ago

dicts_api_documentation

DictsApiDocumentation - JavaScript client for dicts_api_documentation You can download the OpenApi spec file and generate a client in your programming language. If you need additional features for filtering data, please let us know, and we will try to implement them. It may also be helpful: 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 For more information, please visit https://sporting.services

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 dicts_api_documentation --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 dicts_api_documentation 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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 DictsApiDocumentation = require('dicts_api_documentation');

var defaultClient = DictsApiDocumentation.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new DictsApiDocumentation.DictsApi()
api.getDicts().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://dicts.api.sporting.services

ClassMethodHTTP requestDescription
DictsApiDocumentation.DictsApigetDictsGET /v1Get current dicts
DictsApiDocumentation.DictsApigetDictsUsingLocaleGET /v1/{locale}Get dictionaries using the specified locale
DictsApiDocumentation.SystemApigetStatusGET /statusGet status

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication
1.0.0

11 months ago