mirror of https://github.com/vernonkeenan/lib
154 lines
3.8 KiB
Markdown
154 lines
3.8 KiB
Markdown
# stash
|
|
|
|
Stash - JavaScript client for stash
|
|
PDF Storage Microservice
|
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 0.0.2
|
|
- Package version: 0.0.2
|
|
- 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 stash --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 stash 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/GIT_USER_ID/GIT_REPO_ID
|
|
then install it via:
|
|
|
|
```shell
|
|
npm install GIT_USER_ID/GIT_REPO_ID --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 Stash = require('stash');
|
|
|
|
var defaultClient = Stash.ApiClient.instance;
|
|
// Configure API key authorization: ApiKeyAuth
|
|
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
|
|
ApiKeyAuth.apiKey = "YOUR API KEY"
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"
|
|
|
|
var api = new Stash.StashPdfApi()
|
|
var pDFRequest = new Stash.PDFRequest(); // {PDFRequest} An array of new PDF records
|
|
var callback = function(error, data, response) {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
};
|
|
api.postPdfs(pDFRequest, callback);
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://stash.vernonkeenan.com:8080/v1*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*Stash.StashPdfApi* | [**postPdfs**](docs/StashPdfApi.md#postPdfs) | **POST** /pdfs | Create new PDFs
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [Stash.Document](docs/Document.md)
|
|
- [Stash.DocumentResponse](docs/DocumentResponse.md)
|
|
- [Stash.Error](docs/Error.md)
|
|
- [Stash.NewPDF](docs/NewPDF.md)
|
|
- [Stash.PDFRequest](docs/PDFRequest.md)
|
|
- [Stash.RequestMeta](docs/RequestMeta.md)
|
|
- [Stash.ResponseMeta](docs/ResponseMeta.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
|
|
### ApiKeyAuth
|
|
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: X-API-Key
|
|
- **Location**: HTTP header
|
|
|