# api-problem > HTTP Problem Utility Latest version **9.0.2** (published 2023-09-03) · MIT license · 0 weekly downloads ## Install ```sh npm install api-problem pnpm add api-problem yarn add api-problem bun add api-problem ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 9.0.2 | | Published | 2023-09-03 | | First published | 2016-01-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=6 | | Dependencies | 0 | | Unpacked size | 10.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 27 | | Author | Ahmad Nassri | | Maintainers | ahmadnassri | | Keywords | api, http, problem | ## Links - npm: https://www.npmjs.com/package/api-problem - Repository: https://github.com/ahmadnassri/node-api-problem - Homepage: https://github.com/ahmadnassri/api-problem - Issues: https://github.com/ahmadnassri/node-api-problem/issues - Funding: https://github.com/sponsors/ahmadnassri - npm.io page: https://npm.io/package/api-problem ## 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 - 9.0.2 (latest) — 2023-09-03 - 9.0.1 — 2023-01-02 - 9.0.0 — 2022-11-27 - 8.0.0 — 2022-07-28 - 7.0.4 — 2022-07-28 - 7.0.3 — 2021-10-12 - 7.0.2 — 2021-05-18 - 7.0.1 — 2021-02-27 - 7.0.0 — 2021-02-11 - 6.1.4 — 2020-07-30 - 6.1.3 — 2020-07-30 - 6.1.2 — 2020-07-17 - 6.1.1 — 2020-07-17 - 6.1.0 — 2020-07-17 - 6.0.1 — 2019-08-23 - … 14 more at https://npm.io/package/api-problem/versions ## README # API Problem RFC 7807 - Problem Details for HTTP APIs [![license][license-img]][license-url] [![release][release-img]][release-url] [![super linter][super-linter-img]][super-linter-url] [![test][test-img]][test-url] [![semantic][semantic-img]][semantic-url] > [RFC 7807 - Problem Details for HTTP APIs][] ## Install ``` bash npm install api-problem ``` ## API ### Constructor: `Problem(status[, title][, type][, members])` | name | type | required | default | description | referece | |---------------|----------|----------|--------------------|----------------------------------------------------------------------------------------|------------------| | **`status`** | `String` | `✔` | `N/A` | The HTTP status code generated by the origin server for this occurrence of the problem | [Section 3.1][] | | **`title`** | `String` | `✖` | HTTP status phrase | A short, human-readable summary of the problem type | [Section 3.1][] | | **`type`** | `String` | `✖` | `about:blank` | A URI reference that identifies the problem type | [Section 3.1][] | | **`details`** | `Object` | `✖` | `N/A` | additional details to attach to object | [Section 3.1][1] | ``` js import Problem from 'api-problem' // HTTP defaults new Problem(404) //=> { status: '404', title: 'Not Found', type: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404' } // override defaults new Problem(404, 'Oops! Page Not Found') //=> { status: '404', title: 'Oops! Page Not Found', type: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404' } // custom values new Problem(403, 'You do not have enough credit', 'https://example.com/probs/out-of-credit') //=> { status: '403', title: 'You do not have enough credit', type: 'https://example.com/probs/out-of-credit' } // additional details new Problem(403, 'You do not have enough credit', 'https://example.com/probs/out-of-credit', { detail: 'Your current balance is 30, but that costs 50.', instance: '/account/12345/msgs/abc', balance: 30, accounts: ['/account/12345', '/account/67890'] }) //=> { status: '403', title: 'You do not have enough credit', type: 'https://example.com/probs/out-of-credit', detail: 'Your current balance is 30, but that costs 50.', instance: '/account/12345/msgs/abc', balance: 30, accounts: ['/account/12345', '/account/67890'] } // HTTP defaults + Details new Problem(403, { detail: 'Account suspended', instance: '/account/12345', date: '2016-01-15T06:47:01.175Z', account_id: '12345' }) //=> { status: '403', title: 'Forbidden', type: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403', detail: 'Account suspended', instance: '/account/12345', account_id: 12345, 'date: 2016-01-15T06:47:01.175Z' } ``` ### Method : `` `toObject()` returns an object containing all the properties including: *(status, title, type, members)* ``` js const prob = new Problem(403, 'You do not have enough credit', 'https://example.com/probs/out-of-credit', { user_id: 'x123' }) prob.toObject() //=> { status: 403, title: 'You do not have enough credit', type: 'https://example.com/probs/out-of-credit', user_id: 'x123' } ``` ### Method : `` `toString()` returns a simplified, human-readable string representation ``` js const prob = new Problem(403, 'You do not have enough credit', 'https://example.com/probs/out-of-credit') prob.toString() //=> [403] You do not have enough credit ('https://example.com/probs/out-of-credit') ``` ### Method : `` `send(response)` uses [`response.writeHead`][] and [`response.end`][] to send an appropriate error response message with the `Content-Type` response header to [`application/problem+json`][] ``` js import http from 'http' import Problem from 'api-problem' let response = new http.ServerResponse() Problem.send(response) ``` ### Express Middleware A standard connect middleware is provided. The middleware intercepts Problem objects thrown as exceptions and serializes them appropriately in the HTTP response while setting the `Content-Type` response header to [`application/problem+json`][] ``` js import express from 'express' import Problem from 'api-problem' import Middleware from 'api-problem/lib/middleware' const app = express() app.get('/', (req, res) => { throw new Problem(403) }) app.use(Middleware) ``` [RFC 7807 - Problem Details for HTTP APIs]: https://tools.ietf.org/html/rfc7807 [Section 3.1]: https://tools.ietf.org/html/rfc7807#section-3.1 [1]: https://tools.ietf.org/html/rfc7807#section-3.2 [`response.writeHead`]: https://nodejs.org/docs/latest/api/http.html#http_response_writehead_statuscode_statusmessage_headers [`response.end`]: https://nodejs.org/docs/latest/api/http.html#http_response_end_data_encoding_callback [`application/problem+json`]: https://tools.ietf.org/html/rfc7807#section-3 ---- > Author: [Ahmad Nassri](https://www.ahmadnassri.com/) • > Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri) [license-url]: LICENSE [license-img]: https://badgen.net/github/license/ahmadnassri/node-api-problem [release-url]: https://github.com/ahmadnassri/node-api-problem/releases [release-img]: https://badgen.net/github/release/ahmadnassri/node-api-problem [super-linter-url]: https://github.com/ahmadnassri/node-api-problem/actions?query=workflow%3Asuper-linter [super-linter-img]: https://github.com/ahmadnassri/node-api-problem/workflows/super-linter/badge.svg [test-url]: https://github.com/ahmadnassri/node-api-problem/actions?query=workflow%3Atest [test-img]: https://github.com/ahmadnassri/node-api-problem/workflows/test/badge.svg [semantic-url]: https://github.com/ahmadnassri/node-api-problem/actions?query=workflow%3Arelease [semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue --- _Source: https://npm.io/package/api-problem · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._