style_api v0.0.5
style_api
StyleApi - JavaScript client for style_api This is a API document for Stylens Service This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.2
- Package version: 0.0.2
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install style_api --save
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your style_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('style_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/style_api then install it via:
npm install YOUR_USERNAME/style_api --save
For browser
The library also works in the browser environment via npm and browserify. 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, that's to say your javascript file where you actually
use this library):
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:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var StyleApi = require('style_api');
var api = new StyleApi.FeedApi()
var opts = {
'offset': 56, // {Number}
'limit': 56 // {Number}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getFeeds(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://api.stylelens.io
Class | Method | HTTP request | Description |
---|---|---|---|
StyleApi.FeedApi | getFeeds | GET /feeds | |
StyleApi.ImageApi | getImageByHostcodeAndProductNo | GET /images/hosts/{hostCode}/images/{productNo} | Get Image by hostCode and productNo |
StyleApi.ImageApi | getImageById | GET /images/{imageId} | Find Images by ID |
StyleApi.ImageApi | getImages | GET /images | Get Images by imageId |
StyleApi.ImageApi | getImagesByObjectId | GET /images/objects/{objectId} | Query to search images by object id |
StyleApi.ImageApi | getImagesByUserImageFile | POST /images/userImages | Query to search images |
StyleApi.ImageApi | getImagesByUserImageIdAndObjectIndex | GET /images/userImages/{userImageId}/objects/{objectIndex} | Get Images by userImageId and objectIndex |
StyleApi.ObjectApi | getObjectsByImageId | GET /objects/images/{imageId} | Query to search multiple objects |
StyleApi.ObjectApi | getObjectsByUserImageFile | POST /objects | Query to search objects and images |
StyleApi.PlaygroundApi | getPlaygroundObjectsByUserImageFile | POST /playgrounds/objects |
Documentation for Models
- StyleApi.Box
- StyleApi.BoxObject
- StyleApi.BoxesArray
- StyleApi.GetFeedResponse
- StyleApi.GetImageResponse
- StyleApi.GetImagesResponse
- StyleApi.GetObjectsByImageIdResponse
- StyleApi.GetObjectsByImageIdResponseData
- StyleApi.GetObjectsResponse
- StyleApi.GetObjectsResponseData
- StyleApi.Image
- StyleApi.ImagesArray
- StyleApi.SearchImageResponse
- StyleApi.SimImage
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
6 years ago