# api-blueprint-http-formatter

> Format pair of HTTP Request and Response to API Blueprint format

Latest version **0.0.1** (published 2013-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install api-blueprint-http-formatter
pnpm add api-blueprint-http-formatter
yarn add api-blueprint-http-formatter
bun add api-blueprint-http-formatter
```

## 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.1 |
| Published | 2013-07-30 |
| First published | 2013-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Adam Kliment |
| Maintainers | netmilk |
| Keywords | api, blueprint, http |

## Links

- npm: https://www.npmjs.com/package/api-blueprint-http-formatter
- Repository: https://github.com/apiaryio/api-blueprint-http-formatter
- Issues: https://github.com/apiaryio/api-blueprint-http-formatter/issues
- npm.io page: https://npm.io/package/api-blueprint-http-formatter

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2013-07-30

## README

# HTTP API Blueprint formater

[![Build Status](https://travis-ci.org/apiaryio/api-blueprint-http-formatter.png)](https://travis-ci.org/apiaryio/api-blueprint-http-formatter)
[![Dependency Status](https://david-dm.org/apiaryio/api-blueprint-http-formatter.png)](https://david-dm.org/apiaryio/api-blueprint-http-formatter)
[![devDependency Status](https://david-dm.org/apiaryio/api-blueprint-http-formatter/dev-status.png)](https://david-dm.org/apiaryio/api-blueprint-http-formatter#info=devDependencies)


## Usage

It accepts object with `request` and `response` keys in format used by [Gavel](https://github.com/apiaryio/gavel) and returns it back in [API Blueprint format](http://apiblueprint.org)

- [Request format](https://www.relishapp.com/apiary/gavel/v/1-0/docs/data-model#http-request)
- [Response format](https://www.relishapp.com/apiary/gavel/v/1-0/docs/data-model#http-response)


# Example usage

```javascript
var bf = require('./src/api-blueprint-http-formatter');
var post = {
  "request": {
    "method": "POST",
    "uri": "/shopping-cart",
    "headers": {
      "User-Agent": "curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8x zlib/1.2.5",
      "Host": "curltraceparser.apiary.io",
      "Accept": "*/*",
      "Content-Type": "application/json",
      "Content-Length": "39"
    },
    "body": "{ \"product\":\"1AB23ORM\", \"quantity\": 2 }"
  },
  "response": {
    "statusCode": "201",
    "statusMessage": "Created",
    "headers": {
      "Content-Type": "application/json",
      "Date": "Sun, 21 Jul 2009 14:51:09 GMT",
      "X-Apiary-Ratelimit-Limit": "120",
      "X-Apiary-Ratelimit-Remaining": "119",
      "Content-Length": "50",
      "Connection": "keep-alive"
    },
    "body": "{ \"status\": \"created\", \"url\": \"/shopping-cart/2\" }"
  }
};

blueprint = bf.format(post);
console.log(blueprint);
```

## Output is a API Blueprint

```
# POST /shopping-cart
+ Request
    + Headers

            User-Agent:curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8x zlib/1.2.5
            Host:curltraceparser.apiary.io
            Accept:*/*
            Content-Type:application/json
            Content-Length:39

    + Body

            { "product":"1AB23ORM", "quantity": 2 }

+ Response 201
    + Headers

            Content-Type:application/json
            Date:Sun, 21 Jul 2009 14:51:09 GMT
            X-Apiary-Ratelimit-Limit:120
            X-Apiary-Ratelimit-Remaining:119
            Content-Length:50
            Connection:keep-alive

    + Body

            { "status": "created", "url": "/shopping-cart/2" }

```

Use [Protagoinst](https://github.com/apiaryio/protagonist), Api Blueprint Node.js parser to parse or canonical [Snowcrash](https://github.com/apiaryio/snowcrash) parser to get Blueprint AST

## API Reference

`format(pair)` - returns string with message pair in API blueprint format

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