# api-flipbooks

> Handcrafted tool for strict API testing

Latest version **0.0.2** (published 2018-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install api-flipbooks
pnpm add api-flipbooks
yarn add api-flipbooks
bun add api-flipbooks
```

Provides the command `api-flipbooks`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-06-21 |
| First published | 2018-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.11.2 |
| Dependencies | 1 |
| Unpacked size | 16.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Matteo Maronati |
| Maintainers | mattanddev |
| Keywords | API, test |

## Links

- npm: https://www.npmjs.com/package/api-flipbooks
- Repository: https://github.com/MattAndDev/api-flipbooks
- Homepage: https://github.com/MattAndDev/api-flipbooks#readme
- Issues: https://github.com/MattAndDev/api-flipbooks/issues
- npm.io page: https://npm.io/package/api-flipbooks

## Dependencies (1)

- [sort-package-json](https://npm.io/package/sort-package-json.md) ^1.15.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2018-06-21

## README

# api-flipbooks


[![circleci](https://circleci.com/gh/MattAndDev/rm-nm/tree/master.svg?style=shield&circle-token=12aedd82a9a427ca644f90be5404e1a7232da500)](https://circleci.com/gh/MattAndDev/api-flipbooks)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

> Handcrafted tool for strict API testing

## For whom

Run synchronous interdependent api analysis based on configurable files.
This approach results handy for mimicking user behaviour and analyse API endpoint behaviours in real life cases.

## usage

### cli

```
$ npm i -g api-flipbooks
$ api-flipbooks ./flibooks-config-file.js
```

You can also pass a folder, `api-flipbooks` will then look for all files matching `*.flipbook.js`:

```
$ api-flipbooks ./folder-with-configs
```

### api

Install as dev dependency
```
$ npm i api-flipbooks -D
```

Anywhere:

```javascript
const ApiFlipbooks = require('api-flipbooks')
let myApiFlipboks = new ApiFlipbooks({ target: './target-folder' })
```


## flibook file

The best thing is to take a look at the examples in `./flibooks-examples`
Every flipbook file is expected to export an Object with the following properties:

```javascript
module.exports = {

  // title of the flipbook (!) required
  title: 'Title of my flipbook'

  // array of api calls/test to be performed (!) required
  scenes: [
    {
      describe: 'What the scene is doing'
      // http request config  (!) required
      request: {  // 
        // options for node 'http' : 'https' (!) required
        options: {}
        // request body (?) optional
        body: {}
      },

      // validation schemas (!) required
      validation: {
        // expected status code (?) optional
        statusCode: 200,

        // validation schema for response headers as 'key': 'value' (?) optional
        headerSchema: {
          'access-control-allow-credentials': 'true'
        },

        // validation schema for body (?) optional
        bodySchema: {
          // expected body key (?) optional
          schemaKey: {
            // expected variable type for the key as string (?) optional
            _type: 'integer',
            // custom validation as async function should return true or false (?) optional
            should:  async (schemaKey) => { return schemaKey === 10 }
          }
        }
      }
    },

    // lifecycle hooks for this scene (?optional)
    lifecycle: {

      // before the scene is run, access history and scene needs to return the scene (?) optional
      async before (history, scene) {
        return scene
      },

      // after the scene is run, access history and responseBody needs to return history (?) optional
      async after (responseBody, history) {
        return history
      }
    }
  ]
}
```

## current status

Under really heavy development

## special thanks

[reqres.in](https://reqres.in/) for providing test api endpoints

---
_Source: https://npm.io/package/api-flipbooks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._