https://github.com/bavix/gripmock-sdk-js
GripMock SDK JavaScript
https://github.com/bavix/gripmock-sdk-js
gripmock sdk sdk-js
Last synced: about 1 year ago
JSON representation
GripMock SDK JavaScript
- Host: GitHub
- URL: https://github.com/bavix/gripmock-sdk-js
- Owner: bavix
- License: mit
- Created: 2024-02-25T13:28:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-02T05:57:49.000Z (about 1 year ago)
- Last Synced: 2025-06-17T15:25:36.257Z (about 1 year ago)
- Topics: gripmock, sdk, sdk-js
- Language: JavaScript
- Homepage:
- Size: 1.26 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# @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](https://openapi-generator.tech) project:
- API version: 3.0.0
- Package version: 1.0.0
- Generator version: 7.14.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install @bavix/gripmock-sdk --save
```
Finally, you need to build the module:
```shell
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:
```shell
npm install
```
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
```shell
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:
```shell
npm link /path/to/
```
Finally, you need to build the module:
```shell
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:
```shell
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
```shell
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:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
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**](docs/HealthcheckApi.md#liveness) | **GET** /health/liveness | Liveness check
*GripmockSdk.HealthcheckApi* | [**readiness**](docs/HealthcheckApi.md#readiness) | **GET** /health/readiness | Readiness check
*GripmockSdk.ServicesApi* | [**serviceMethodsList**](docs/ServicesApi.md#serviceMethodsList) | **GET** /services/{serviceID}/methods | Service methods
*GripmockSdk.ServicesApi* | [**servicesList**](docs/ServicesApi.md#servicesList) | **GET** /services | Services
*GripmockSdk.StubsApi* | [**addStub**](docs/StubsApi.md#addStub) | **POST** /stubs | Add a new stub to the store
*GripmockSdk.StubsApi* | [**batchStubsDelete**](docs/StubsApi.md#batchStubsDelete) | **POST** /stubs/batchDelete | Deletes a pack by IDs
*GripmockSdk.StubsApi* | [**deleteStubByID**](docs/StubsApi.md#deleteStubByID) | **DELETE** /stubs/{uuid} | Deletes stub by ID
*GripmockSdk.StubsApi* | [**findByID**](docs/StubsApi.md#findByID) | **GET** /stubs/{uuid} | Get Stub by ID
*GripmockSdk.StubsApi* | [**listStubs**](docs/StubsApi.md#listStubs) | **GET** /stubs | Getting a list of stubs
*GripmockSdk.StubsApi* | [**listUnusedStubs**](docs/StubsApi.md#listUnusedStubs) | **GET** /stubs/unused | Getting a list of unused stubs
*GripmockSdk.StubsApi* | [**listUsedStubs**](docs/StubsApi.md#listUsedStubs) | **GET** /stubs/used | Getting a list of used stubs
*GripmockSdk.StubsApi* | [**purgeStubs**](docs/StubsApi.md#purgeStubs) | **DELETE** /stubs | Remove all stubs
*GripmockSdk.StubsApi* | [**searchStubs**](docs/StubsApi.md#searchStubs) | **POST** /stubs/search | Stub storage search
## Documentation for Models
- [GripmockSdk.AddStubRequest](docs/AddStubRequest.md)
- [GripmockSdk.MessageOK](docs/MessageOK.md)
- [GripmockSdk.Method](docs/Method.md)
- [GripmockSdk.SearchRequest](docs/SearchRequest.md)
- [GripmockSdk.SearchResponse](docs/SearchResponse.md)
- [GripmockSdk.Service](docs/Service.md)
- [GripmockSdk.Stub](docs/Stub.md)
- [GripmockSdk.StubHeaders](docs/StubHeaders.md)
- [GripmockSdk.StubInput](docs/StubInput.md)
- [GripmockSdk.StubOutput](docs/StubOutput.md)
## Documentation for Authorization
Endpoints do not require authorization.