# apidoc-summary

> Generate a summary page from Apidoc api_data.json

Latest version **0.0.4** (published 2017-04-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install apidoc-summary
pnpm add apidoc-summary
yarn add apidoc-summary
bun add apidoc-summary
```

## 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.4 |
| Published | 2017-04-25 |
| First published | 2017-04-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Florin Alexandrescu |
| Maintainers | florinmq |
| Keywords | apidoc, js, summary |

## Links

- npm: https://www.npmjs.com/package/apidoc-summary
- Repository: https://github.com/pianosnake/apidoc-summary
- Homepage: https://github.com/pianosnake/apidoc-summary#readme
- Issues: https://github.com/pianosnake/apidoc-summary/issues
- npm.io page: https://npm.io/package/apidoc-summary

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.0.4 (latest) — 2017-04-25
- 0.0.3 — 2017-04-25
- 0.0.2 — 2017-04-25
- 0.0.1 — 2017-04-24

## README

# apiDoc Summary

Generate an HTML summary page from the api_data.json file created by [apiDoc](http://apidocjs.com/) min version 0.17. The summary
is a table with HTML methods as columns (by default: GET, POST, PATCH, DELETE) and the grouped endpoints as the rows.
Endpoint descriptions fill in the cells.

![apiDocSummary Example image](example.png "Example table")


Call from Gulp like so, making sure that the apiDoc task runs first:

``` javascript

const apidocSummary = require('apidoc-summary');

...

gulp.task('apidoc-summary', ['apidoc'], function(cb){
  apidocSummary({
    src: __dirname + '/public/docs/api_data.json', //required
    dest: __dirname + '/public/docs/summary.html',  //required
    columns: ['get', 'post', 'put', 'delete'] //optional
  }, cb);
});
```

The options `src` and `dest` parameters are required. Optionally, a `columns` parameter can be passed with an array of the
HTTP methods that should be output. At least one method should be passed.

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