Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucid-services/serviser-sdk
SDK client plugin for `serviser` based apps and a SDK package generator
https://github.com/lucid-services/serviser-sdk
axios client http sdk
Last synced: about 21 hours ago
JSON representation
SDK client plugin for `serviser` based apps and a SDK package generator
- Host: GitHub
- URL: https://github.com/lucid-services/serviser-sdk
- Owner: lucid-services
- License: gpl-3.0
- Created: 2019-02-07T09:02:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-03-11T14:46:13.000Z (over 5 years ago)
- Last Synced: 2024-09-21T12:43:32.917Z (about 2 months ago)
- Topics: axios, client, http, sdk
- Language: JavaScript
- Homepage:
- Size: 151 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/lucid-services/serviser-sdk)
### Peer Dependencies
* `serviser` >= `1.0.0`
* `serviser-doc` >= `2.0.0`
### Generating a SDK client npm package for a `serviser` based application
Requires `serviser-doc` package to be plugged in along the `serviser-sdk` plugin.
Load them at bottom of your `index.js`:
```javascript
//index.js
//...
const Service = require('serviser');
const service = new Service(/*...*/);
module.exports = service;
//...
//Load the plugins
require('serviser-doc');
require('serviser-sdk');
```
Make sure that your project's `index.js` exports the `Service` instance object.
and then just call the `build:sdk` command:
```bash
> cd ./path/to/my/serviser-project
#builds SDKs for all supported apps (zip files are written to cwd)
project/root> ./node_modules/.bin/serviser build:sdk
#view available cmd options
project/root> ./node_modules/.bin/serviser build:sdk --help
```
An alternative way is to use standalone `serviser-sdk` executable and provide it with API specification source from which SDKs are generated:
```bash
# generates SDKs into zip packages in cwd
> serviser-sdk --specs "http://docs.service.com/specs" #url must return json in format {"v1.0": {/*Open API 2.0/3.0 specs*/}}
> # eventually
> ./node_modules/.bin/serviser build:sdk --help
> ./node_modules/.bin/serviser-sdk --help
> ./node_modules/.bin/serviser-doc --help
```
### npm package version schema of generated SDKs
example:
serviser-sdk: `1.0.0`
your-project-name: `0.5.0`
your-project-name-private-sdk: `1.0.0-x.0.5.0`
your-project-name-public-sdk: `1.0.0-x.0.5.0`
### Defining a generated SDK module as a npm dependency
```json
{
"dependencies": {
"your-project-name-private-sdk": "^1.0.0-x.0.5.0 <1.0.0-x.1.0.0"
}
}
```
The above version restriction will match for example:
* `1.0.0-x.0.5.0`
* `1.0.0-x.0.6.0`
* `1.0.0-x.0.6.1`
but will **NOT** match:
* `1.0.0-x.1.0.0`
* `1.0.1-x.0.5.0`
* `1.1.0-x.0.5.0`
* `2.1.0-x.0.5.0`