digital_identity v1.0.1
digital_identity
DigitalIdentity - JavaScript client for digital_identity No description This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.1
- Package version: 1.0.1
- Build package: 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 digital_identity --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 digital_identity from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('digital_identity')
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/YOUR_USERNAME/digital_identity then install it via:
npm install YOUR_USERNAME/digital_identity --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 DigitalIdentity = require('digital_identity');
var api = new DigitalIdentity.CheckApi()
var getInfoBody = new DigitalIdentity.QueryParams(); // {QueryParams} Body
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getInfo(getInfoBody, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8081/rest
Class | Method | HTTP request | Description |
---|---|---|---|
DigitalIdentity.CheckApi | getInfo | POST /info | |
DigitalIdentity.CheckApi | isAlive | GET /alive | |
DigitalIdentity.PreferencesApi | updatePreferences | POST /preferences |
Documentation for Models
- DigitalIdentity.CategoryEnum
- DigitalIdentity.DateAndTime
- DigitalIdentity.DateAndTimeInterval
- DigitalIdentity.Generic
- DigitalIdentity.GenericResponse
- DigitalIdentity.Meta
- DigitalIdentity.MongoDSConfiguration
- DigitalIdentity.MongoDSEntry
- DigitalIdentity.Props
- DigitalIdentity.QueryParams
- DigitalIdentity.QueryParamsPrj
- DigitalIdentity.QueryParamsSort
- DigitalIdentity.QueryParamsSortInner
- DigitalIdentity.SocialNetworkEnum
- DigitalIdentity.SocialProfile
- DigitalIdentity.StoreObject
- DigitalIdentity.Tags
- DigitalIdentity.UpdatePreferencesBody
- DigitalIdentity.VectorPrefs
- DigitalIdentity.VectorPrefsItem
Documentation for Authorization
All endpoints do not require authorization.
5 years ago