Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doowb/fly-api
Fly.io API wrapper for simplifying REST calls.
https://github.com/doowb/fly-api
api fly flyio rest-api restful
Last synced: 24 days ago
JSON representation
Fly.io API wrapper for simplifying REST calls.
- Host: GitHub
- URL: https://github.com/doowb/fly-api
- Owner: doowb
- License: mit
- Created: 2017-08-22T00:34:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-08-23T21:04:07.000Z (about 7 years ago)
- Last Synced: 2024-10-10T17:22:21.044Z (about 1 month ago)
- Topics: api, fly, flyio, rest-api, restful
- Language: JavaScript
- Homepage: https://github.com/doowb
- Size: 10.7 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# fly-api [](https://www.npmjs.com/package/fly-api) [](https://npmjs.org/package/fly-api) [](https://npmjs.org/package/fly-api) [](https://fly.io/slack/)
> Fly.io API wrapper for simplifying REST calls.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save fly-api
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add fly-api
```
## Usage
```js
var Fly = require('fly-api');
```
## API
### [Fly](index.js#L18)
Create a new Fly instance using the given options.
**Params**
* `options` **{Object}**: Options for setting authentication token and api url.
* `options.token` **{String}**: Authentication token for fly.io api.
* `options.url` **{String}**: fly.io api url. Defaults to (https://fly.io/api/v1/)
**Example**
```js
var fly = new Fly({token: 'xxxx'});
```
### [.get](index.js#L51)
Send a GET request to the specified `path` at the fly.io api url.
**Params**
* `path` **{String}**: Path to use after the api url
* `options` **{Object}**: Options
* `cb` **{Function}**: Callback function that takes an `err` and `result` parameters.
**Example**
```js
fly.get('sites/doowb/hostnames', {}, function(err, result) {
if (err) {
console.error(err);
return;
}
console.log(result);
//=> {
//=> "data": {
//=> "attributes": {
//=> "hostname": "foo.doowb.com"
//=> }
//=> }
//=> }
});
```
### [.post](index.js#L90)
Send a POST request to the specified `path` at the fly.io api url.
**Params**
* `path` **{String}**: Path to use after the api url
* `data` **{Object}**: The payload to send in the post.
* `cb` **{Function}**: Callback function that takes an `err` and `result` parameters.
**Example**
```js
var options = {
data: {
attributes: { hostname: 'bar.doowb.com' }
}
};
fly.post('sites/doowb/hostnames', options, function(err, result) {
if (err) {
console.error(err);
return;
}
console.log(result);
//=> {
//=> "data": {
//=> "attributes": {
//=> "hostname": "bar.doowb.com"
//=> }
//=> }
//=> }
});
```
## About
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://doowb.com).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 21, 2017._