shr_rest_client v0.0.6
shr_rest_client
ShrRestClient - JavaScript client for shr_rest_client SHR REST Client This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.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 shr_rest_client --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 shr_rest_client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('shr_rest_client')
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/shr_rest_client then install it via:
npm install YOUR_USERNAME/shr_rest_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, 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 ShrRestClient = require('shr_rest_client');
var api = new ShrRestClient.DefaultApi()
var shrId = "shrId_example"; // {String} ID of patient to return
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getPatientById(shrId, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:3001/api
Class | Method | HTTP request | Description |
---|---|---|---|
ShrRestClient.DefaultApi | getPatientById | GET /patient/{shrId} | Find patient by SHR ID |
ShrRestClient.DefaultApi | patientOptions | OPTIONS /patient | |
ShrRestClient.DefaultApi | updatePatientRecord | PUT /patient | Update a single patient record |
Documentation for Models
Documentation for Authorization
All endpoints do not require authorization.