Registry / serialization / api-blueprint-http-formatter

api-blueprint-http-formatter

library0.0.1jsnpmunverified

The `api-blueprint-http-formatter` package is a JavaScript utility designed to transform structured HTTP request and response objects into a string formatted according to the API Blueprint specification. It takes a JavaScript object containing `request` and `response` keys, adhering to the data model typically used by the Gavel validation tool, and outputs a textual representation suitable for API Blueprint documentation. The current and only released version is 0.0.1. This project appears to be abandoned, with its last commit on GitHub dating back to 2014, and is no longer actively maintained. The broader API Blueprint ecosystem has seen a general decline in new tooling and adoption, with the industry largely shifting towards OpenAPI/Swagger for API description, partly due to the shutdown of major platforms like Apiary.io which championed API Blueprint. This package focuses exclusively on formatting and does not offer parsing, validation, or other API Blueprint-related functionalities.

serialization http-networking

npm install api-blueprint-http-formatter

github ↗package ↗

INSTALL

IMPORT

SIG · API-BLUEPRINT-HTTP

api-blueprint-http-formatter

serializationjavascriptv0.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

format

✓ const formatter = require('api-blueprint-http-formatter').format;

✗ import { format } from 'api-blueprint-http-formatter';

This package is a CommonJS module. Direct ES module `import` syntax is not supported without a compatibility layer or bundler configuration. The primary export is the `format` function.

default export

✓ const bf = require('api-blueprint-http-formatter'); const blueprint = bf.format(post);

✗ import bf from 'api-blueprint-http-formatter';

The package exports an object with a `format` method. While you can `require` the module and then access `.format`, it's often clearer to destructure or directly assign the `format` function if it's the only one you need. Direct default ESM imports will not work.

* as formatter

✓ const formatterModule = require('api-blueprint-http-formatter');

✗ import * as formatterModule from 'api-blueprint-http-formatter';

For CommonJS modules, `require` returns the module.exports object. Using `import * as` for a CJS module in an ESM context might work depending on your build setup, but `require` is the intended usage.

Demonstrates how to use the `format` function to convert an HTTP request/response pair into an API Blueprint formatted string.

Debug

Known issues

breakingThis package is fundamentally unmaintained, with its last commit in 2014 and a 0.0.1 version. It is unlikely to receive updates for security vulnerabilities, bug fixes, or compatibility with newer Node.js versions or API Blueprint specification changes.

fix

Consider migrating to tools that support OpenAPI/Swagger, which is the current industry standard for API description and has robust, actively maintained tooling.

affects: >=0.0.1

gotchaThe API Blueprint specification, while once popular, has largely been superseded by OpenAPI/Swagger. Many modern API design and documentation tools, including Apiary.io (a former champion of API Blueprint), have either shut down or shifted focus, making API Blueprint a less supported standard.

fix

For new projects, prefer using OpenAPI/Swagger. If maintaining existing API Blueprint documentation, be aware of the limited tooling and community support. Tools like `apib2openapi` might help with migration.

affects: >=0.0.1

gotchaThis package is a CommonJS module and does not natively support ES module (`import`) syntax. Attempting to `import` it directly in an ESM context will result in an error unless a transpilation step or a CommonJS compatibility loader is used.

fix

Use `const bf = require('api-blueprint-http-formatter');` for importing this module.

affects: >=0.0.1

gotchaThe package expects input objects to conform to the HTTP request and response data models used by the Gavel validation tool. Deviations from this precise structure may lead to malformed or incorrect API Blueprint output.

fix

Refer to Gavel's documentation for the exact expected `request` and `response` object structures to ensure correct formatting.

affects: >=0.0.1

Errors

Common errors & fixes

TypeError: bf.format is not a function

This typically occurs if the module was `require`d incorrectly, or if the path to the formatter was wrong, leading to `bf` not being the expected module object with a `format` method.

fix

Ensure you are using `const bf = require('api-blueprint-http-formatter');` and then calling `bf.format(post);`. If requiring from a local file, ensure the path `require('./src/api-blueprint-http-formatter')` is correct relative to your script.

Error: Cannot find module 'api-blueprint-http-formatter'

The package is not installed or not resolvable by Node.js.

fix

Install the package using npm: `npm install api-blueprint-http-formatter` or ensure it's listed in your `package.json` dependencies and `npm install` has been run.

Upgrade

Version history

0.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

26 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/apiaryio/api-blueprint-http-formatter ↗

packagehttps://www.npmjs.com/package/api-blueprint-http-formatter ↗