@starinformatics/ncats-trapi-client

client - JavaScript client for @starinformatics/ncats-trapi-client
OpenAPI for NCATS Biomedical Translator Reasoners
This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

$3

#### npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

``shell
npm install @starinformatics/ncats-trapi-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 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 @starinformatics/ncats-trapi-client from, and run:

`shell
npm link /path/to/
`

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

`shell
npm install GIT_USER_ID/GIT_REPO_ID --save
`

$3

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

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

$3

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 instruction and execute the following JS code:

`javascript
var client = require('@starinformatics/ncats-trapi-client');


var api = new client.PredicatesApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.predicates(callback);

``

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
client.PredicatesApi | predicates | GET /predicates | Get supported relationships by source and target
client.QueryApi | query | POST /query | Query reasoner via one of several inputs

Documentation for Models

- client.Attribute
- client.Edge
- client.EdgeBinding
- client.KnowledgeGraph
- client.LogEntry
- client.Message
- client.Node
- client.NodeBinding
- client.QEdge
- client.QNode
- client.Query
- client.QueryGraph
- client.Response
- client.Result

Documentation for Authorization

All endpoints do not require authorization.