noobchef_api
v0.0.2
Published
Noobchef_api
Downloads
4
Readme
noobchef_api
NoobchefApi - JavaScript client for noobchef_api Noobchef api This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- 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 noobchef_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 noobchef_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('noobchef_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/noobchef_api then install it via:
npm install YOUR_USERNAME/noobchef_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 NoobchefApi = require('noobchef_api');
var api = new NoobchefApi.AuthApi()
var authorization = "authorization_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.v1AuthCheckGet(authorization, callback);
Documentation for API Endpoints
All URIs are relative to http://127.0.0.1:3000/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NoobchefApi.AuthApi | v1AuthCheckGet | GET /v1/auth/check | NoobchefApi.AuthApi | v1AuthLoginExternalPost | POST /v1/auth/login-external | NoobchefApi.AuthApi | v1AuthLoginPost | POST /v1/auth/login | NoobchefApi.AuthApi | v1AuthSignupPost | POST /v1/auth/signup | NoobchefApi.AuthApi | v1AuthUpdatePasswordPut | PUT /v1/auth/update-password | NoobchefApi.RecipesApi | v1RecipesGet | GET /v1/recipes | NoobchefApi.RecipesApi | v1RecipesPost | POST /v1/recipes | NoobchefApi.RecipesApi | v1RecipesRecipeIdDelete | DELETE /v1/recipes/{recipeId} | NoobchefApi.RecipesApi | v1RecipesRecipeIdGet | GET /v1/recipes/{recipeId} | NoobchefApi.RecipesApi | v1RecipesRecipeIdPut | PUT /v1/recipes/{recipeId} | NoobchefApi.SpecificationApi | v1SpecGet | GET /v1/spec | NoobchefApi.UsersApi | v1UsersGet | GET /v1/users | NoobchefApi.UsersApi | v1UsersMeGet | GET /v1/users/me | NoobchefApi.UsersApi | v1UsersUserIdDelete | DELETE /v1/users/{userId} | NoobchefApi.UsersApi | v1UsersUserIdFreezersFreezerIdGet | GET /v1/users/{userId}/freezers/{freezerId} | NoobchefApi.UsersApi | v1UsersUserIdFreezersFreezerIdPut | PUT /v1/users/{userId}/freezers/{freezerId} | NoobchefApi.UsersApi | v1UsersUserIdFreezersPost | POST /v1/users/{userId}/freezers | NoobchefApi.UsersApi | v1UsersUserIdGet | GET /v1/users/{userId} | NoobchefApi.UsersApi | v1UsersUserIdPut | PUT /v1/users/{userId} | NoobchefApi.UsersApi | v1UsersUserIdRanksRankIdGet | GET /v1/users/{userId}/ranks/{rankId} |
Documentation for Models
- NoobchefApi.Error
- NoobchefApi.FreezerItemRequest
- NoobchefApi.FreezerItemResponse
- NoobchefApi.FreezerRequest
- NoobchefApi.FreezerResponse
- NoobchefApi.IngredientItem
- NoobchefApi.Ranking
- NoobchefApi.RecipeRequest
- NoobchefApi.RecipeResponse
- NoobchefApi.RecipeStep
- NoobchefApi.RecipeWrapper
- NoobchefApi.Tag
- NoobchefApi.TokenData
- NoobchefApi.TokenExternalRequest
- NoobchefApi.TokenRequest
- NoobchefApi.UpdatePasswordRequest
- NoobchefApi.UserRequest
- NoobchefApi.UserResponse
- NoobchefApi.UserUpdateRequest
- NoobchefApi.UserWrapper