Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zenmate/pingster-core
:squirrel: Test API requests without leaving your project!
https://github.com/zenmate/pingster-core
frontend hcd pingster
Last synced: 1 day ago
JSON representation
:squirrel: Test API requests without leaving your project!
- Host: GitHub
- URL: https://github.com/zenmate/pingster-core
- Owner: zenmate
- License: other
- Created: 2018-01-26T11:36:07.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T00:26:43.000Z (over 5 years ago)
- Last Synced: 2024-10-28T14:17:19.005Z (21 days ago)
- Topics: frontend, hcd, pingster
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pingster
[](https://badge.fury.io/js/pingster)
> Never let your APIs down! Pingster is the tool that allows you test any API requests that are used inside your apps and projects.
## Install
```bash
npm install pingster
```
## Usage
### CLI
In the root of your project create `pingster.yml` file that looks like:
```yaml
httpbin:
url: https://httpbin.org/get?hello=world
expect:
status: 200
```
then run command inside your folder:
```bash
pingster
```
and it will test if that url returns `200` as you expect!
#### Options
```bash
Options:
-c, --config optional path to config file wtih .yml ext
-d, --debug, --verbose enable verbose logging mode
-h, --help print help
-v, --version print version
```
### Programmatic
It is also possible to use Pingster inside your code directly:
```js
const pingster = require('pingster');
const config = {
httpbin: {
url: 'https://httpbin.org/get?hello=world'
expect: {
status: 200
}
}
};
pingster.tester(config).then(testResults => {
console.log(testResults);
});
```
#### API
- `loadConfig(path: String) -> Object` - load and parse YAML config file from specified path and get a config object in return
- `parseConfig(yaml: String) -> Object` - parse YAML string and get a config object in return
- `tester(config: Object) -> Promise` - run tests on APIs specified in config object, returns a Promise
### Config structure
```yaml
# api name
httpbin:
# api url that will be tested
url: https://httpbin.org/get?hello=world
# data that will be tested to match with response
expect:
status: 200
data:
foo: bar
num: 123
bool: true
obj:
key: value
headers:
content-type: application/json
```
## Pingster Tools
Furthermore you can also easily setup and self-host your own Pingster web service that will run API tests of your projects and show the results in beautiful UI. Here are the apps that will help you:
- [pingster-server](https://github.com/zenmate/pingster-server) - Node.js backend that provides REST API and scheduled Pingster test runner for your GitHub repositories
---