パッケージの詳細

behance-api

Polyneue19MIT1.1.5

Node.js wrapper for the Behance API

behance, api, wrapper

readme

behance-api

Build Status Coverage Status

Node.js wrapper for the Behance API, see the Behance API docs for more details. In order to use the Behance API you will need to register your application to receive your API key.

Installation

Install package with NPM

npm install behance-api --save

Usage

Making a request looks something like this:

// Dependencies
const Behance = require('behance-api');
const Be = new Behance(API_KEY);

// Get Projects Data
Be.projects({q: 'motorcycle'}, function (err, res, data) {
  if (err) throw err;

  // Do something with the data received from the API
  console.dir(data);
});

The snippet above will make a request to the Behance API and receive the first page of results that match the motorcycle query for the /projects/ endpoint. It then displays that data in the terminal. Every callback gets three arguments; an error (if there is one), the HTTP response, and a JSON object.

API

For documentation around accessing all of the endpoints, see API Docs

License

MIT

更新履歴

Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.1.4 - 2017-05-26

Added

  • Example documentation.

Changed

  • Update Chai to v4.0.0.
  • Query Validation from JSON to a module.
  • Separated utility functions from main module.
  • Minor update to API doc format.
  • Fixed compareKeys validation issue.

1.1.3 - 2017-05-02

Changed

  • Changed to using airbnb standards.

1.1.2 - 2017-04-25

Changed

  • Added logo to npmignore.
  • Updated license year.

Added

  • New API documentation.
  • README now references examples and API docs.

1.1.1 - 2017-04-19

Changed

  • Minor code style updates in readme.
  • Fix for behane logo not showing on npmjs.com.

1.1.0 - 2017-04-19

Added

  • Linting for coding standards (standardjs).
  • Added logo per Behance branding guidelines.
  • Be.teams() for the teams endpoint.
  • Be.team() - team endpoint.
  • Be.teamProjects() - team projects endpoint.

Changed

  • team endoints added to readme.
  • updated travis file to only run on develop or master.

1.0.0 - 2016-11-16

Added

  • Validation for request that use queries.
  • Test suite covers 100% of code now.
  • Argument validation for endpoints that use an ID and options.
  • New Changelog file for better tracking of updates.

Changed

  • Moved requestHandler and requestUrl into the private scope.
  • Minor code style changes.
  • Changed from querystring module to qs module.
  • Test suite structure update.
  • Update to README layout for API information.
  • Simplified example js file.

0.1.2 - 2016-10-28

Removed

  • Removing coverage from npm package.

0.1.1 - 2016-10-28

Removed

  • Remove example js from npm package.

0.1.0 - 2016-10-28

Added

  • Wrote initial API functions.
  • Updated README with new API usage and examples.
  • Set up test suite.

0.0.2 - 2016-10-26

Added

  • Initial setup of README, Packages, and License for repo and npm.