1.0.0 • Published 1 year ago

webpwnize v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

webpwnize

Webpwnize - JavaScript client for webpwnize webpwnize the internetz 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 webpwnize --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 webpwnize 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/loeken/webpwnize then install it via:

    npm install loeken/webpwnize --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 Webpwnize = require('webpwnize');


var api = new Webpwnize.AuthApi()
var body = new Webpwnize.ModelsInputUser(); // {ModelsInputUser} provide a json containing your email and password
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authPost(body, callback);

Documentation for API Endpoints

All URIs are relative to https://webpwnize.loeken.xyz/api/v1

ClassMethodHTTP requestDescription
Webpwnize.AuthApiauthPostPOST /authLogin to the application, generates a JWT
Webpwnize.AuthApioauthGoogleGetGET /oauth/googleLogin to the application via google, generates a JWT
Webpwnize.AuthApirefreshPostPOST /refreshIssue a new JWT token by using the refresh_token
Webpwnize.ContentApicontentGetGET /contentlists all content
Webpwnize.ContentApicontentIdDeleteDELETE /content/{id}delete specific content by id
Webpwnize.ContentApicontentIdGetGET /content/{id}list specific content by id
Webpwnize.ContentApicontentIdPutPUT /content/{id}update specific content by id
Webpwnize.ContentApicontentPostPOST /contentCreates a new Content account
Webpwnize.ImageApiimageGetGET /imagelists all image
Webpwnize.ImageApiimageIdDeleteDELETE /image/{id}delete specific image by id
Webpwnize.ImageApiimageIdGetGET /image/{id}list specific image by id
Webpwnize.ImageApiimageIdPutPUT /image/{id}update specific image by id
Webpwnize.ImageApiimagePostPOST /imageCreates a new Image account
Webpwnize.UserApiuserGetGET /userlists all user
Webpwnize.UserApiuserIdDeleteDELETE /user/{id}delete specific user by id
Webpwnize.UserApiuserIdGetGET /user/{id}list specific user by id
Webpwnize.UserApiuserIdPutPUT /user/{id}update specific user by id
Webpwnize.UserApiuserPostPOST /userCreates a new User account

Documentation for Models

Documentation for Authorization

BearerAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
1.0.0

1 year ago