Skip to content

bavix/gripmock-sdk-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6a3d6de · Feb 26, 2024

History

46 Commits
Feb 26, 2024
Feb 25, 2024
Feb 25, 2024
Feb 26, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 25, 2024
Feb 26, 2024
Feb 26, 2024
Feb 25, 2024
Feb 25, 2024
Feb 26, 2024
Feb 26, 2024

Repository files navigation

@bavix/gripmock-sdk

GripmockSdk - JavaScript client for @bavix/gripmock-sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.4.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @bavix/gripmock-sdk --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 @bavix/gripmock-sdk 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 GripmockSdk = require('@bavix/gripmock-sdk');


var api = new GripmockSdk.HealthcheckApi()
api.liveness().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://raw.githubusercontent.com/api

Class Method HTTP request Description
GripmockSdk.HealthcheckApi liveness GET /health/liveness Liveness check
GripmockSdk.HealthcheckApi readiness GET /health/readiness Readiness check
GripmockSdk.StubsApi addStub POST /stubs Add a new stub to the store
GripmockSdk.StubsApi batchStubsDelete POST /stubs/batchDelete Deletes a pack by IDs
GripmockSdk.StubsApi deleteStubByID DELETE /stubs/{uuid} Deletes stub by ID
GripmockSdk.StubsApi listStubs GET /stubs Getting a list of stubs
GripmockSdk.StubsApi listUnusedStubs GET /stubs/unused Getting a list of unused stubs
GripmockSdk.StubsApi listUsedStubs GET /stubs/used Getting a list of used stubs
GripmockSdk.StubsApi purgeStubs DELETE /stubs Remove all stubs
GripmockSdk.StubsApi searchStubs POST /stubs/search Stub storage search

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.