Skip to content
/ pact-api Public

A JS wrapper around Pact's APIs to make it faster and easier to use in client/server JS projects.

Notifications You must be signed in to change notification settings

iest/pact-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PactAPI

A JS wrapper around Pact's APIs to make it faster and easier to use in client/server JS projects.

Each method returns a promise. The promise will resolve to the raw output of the Pact API, or reject with a (hopefully) helpful error message.

Usage

  1. npm install https://github.com/PactCoffee/pact-api
  2. Use in your project:
import {getOrders} from 'PactAPI';

getOrders(myUserID).then(doStuffWithOrders, handleFailure);

This project currently requires the use of a module build tool like browserify or webpack. The output dist is simply babel transformed code to ES5. In future this will be a completely packaged dist.

Available Methods

TODO

Core API docs

  1. Hit http://petstore.swagger.io
  2. Enter https://core.pactcoffee.com/v1/api_docs into the input
  3. View docs

PactApp API docs

TODO

Running tests

TODO

Contributing/Building

  1. Fork
  2. Make changes
  3. npm run build
  4. Commit changes
  5. Appropriate version bump: npm version major|minor|patch
  6. Open a PR

About

A JS wrapper around Pact's APIs to make it faster and easier to use in client/server JS projects.

Resources

Stars

Watchers

Forks

Packages

No packages published