the_mobb_m_lab
v1.0.2
Published
This_is_the_mLab_API_for_the_Mobb_Database
Downloads
3
Readme
the_mobb_m_lab
TheMobbMLab - JavaScript client for the_mobb_m_lab This is the mLab API for the Mobb Database 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 the_mobb_m_lab --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 the_mobb_m_lab from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('the_mobb_m_lab')
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/the_mobb_m_lab then install it via:
npm install YOUR_USERNAME/the_mobb_m_lab --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 TheMobbMLab = require('the_mobb_m_lab');
var defaultClient = TheMobbMLab.ApiClient.instance;
// Configure API key authorization: APIKeyQueryParam
var APIKeyQueryParam = defaultClient.authentications['APIKeyQueryParam'];
APIKeyQueryParam.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyQueryParam.apiKeyPrefix['apiKey'] = "Token"
var api = new TheMobbMLab.CategoriesApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.allCategories(callback);
Documentation for API Endpoints
All URIs are relative to https://api.mlab.com/api/1/databases/tkhb_mongodb
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TheMobbMLab.CategoriesApi | allCategories | GET /collections/categories | returns all categories TheMobbMLab.CollectionsApi | returnsCollections | GET /collections | returns all db collections TheMobbMLab.ListingsApi | createListing | POST /collections/listings | adds black owned business to db TheMobbMLab.ListingsApi | returnAllListings | GET /collections/listings | returns all black owned business TheMobbMLab.ListingsApi | returnOneListing | GET /collections/listings/{_id} | returns one black owned business\ TheMobbMLab.UsersApi | allUsers | GET /collections/users | returns all users
Documentation for Models
Documentation for Authorization
APIKeyQueryParam
- Type: API key
- API key parameter name: apiKey
- Location: URL query string