space_pirates_api
v1.1.0
Published
APi_for_Space_Pirates_backend_to_handle_users_lobbies_friends_and_purchases_
Downloads
31
Readme
space_pirates_api
SpacePiratesApi - JavaScript client for space_pirates_api APi for Space Pirates backend to handle users, lobbies, friends, and purchases. This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.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 space_pirates_api --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your space_pirates_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --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):
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 SpacePiratesApi = require('space_pirates_api');
var defaultClient = SpacePiratesApi.ApiClient.instance;
// Configure API key authorization: sessionAuth
var sessionAuth = defaultClient.authentications['sessionAuth'];
sessionAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//sessionAuth.apiKeyPrefix['token'] = "Token"
var api = new SpacePiratesApi.DefaultSpacePiratesAPI()
var userId = "userId_example"; // {String} the user's UUID (unique)
var friendUserId = "friendUserId_example"; // {String} the user's UUID (unique)
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.acceptFriendReq(userId, friendUserId, callback);
Documentation for API Endpoints
All URIs are relative to https://spacepirates.uc.r.appspot.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SpacePiratesApi.DefaultSpacePiratesAPI | acceptFriendReq | PATCH /users/{userId}/friendRequests/{friendUserId} | Accept a friend request SpacePiratesApi.DefaultSpacePiratesAPI | createFriend | POST /users/{userId}/friendRequests/{friendUserId} | create a friend relation SpacePiratesApi.DefaultSpacePiratesAPI | createUser | POST /users/{userId} | Creates a new user. SpacePiratesApi.DefaultSpacePiratesAPI | deleteFriend | DELETE /users/{userId}/friends/{friendId} | delete a friend SpacePiratesApi.DefaultSpacePiratesAPI | deleteUser | DELETE /users/{userId} | Delete a user SpacePiratesApi.DefaultSpacePiratesAPI | getUser | GET /users/{userId} | SpacePiratesApi.DefaultSpacePiratesAPI | readUserFriendRequests | GET /users/{userId}/friendRequests | read a users friend requests SpacePiratesApi.DefaultSpacePiratesAPI | readUserFriends | GET /users/{userId}/friends | read a users friends SpacePiratesApi.DefaultSpacePiratesAPI | updateUserExperience | PATCH /users/{userId}/experience | Updates user experience
Documentation for Models
- SpacePiratesApi.FriendReqSchema
- SpacePiratesApi.FriendSchema
- SpacePiratesApi.NewUserSchema
- SpacePiratesApi.UpdateExperienceSchema
- SpacePiratesApi.UserResSchema
Documentation for Authorization
sessionAuth
- Type: API key
- API key parameter name: token
- Location: HTTP header
sigAuth
- Type: API key
- API key parameter name: signature
- Location: HTTP header