Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
hafas-rest-api
Advanced tools
Expose a HAFAS client via an HTTP REST API.
Weekly downloads
Readme
Expose a hafas-client@6
instance as an HTTP REST API.
npm install hafas-rest-api
import {createClient as createHafas} from 'hafas-client'
import {profile as dbProfile} from 'hafas-client/p/db/index.js'
import {createHafasRestApi as createApi} from 'hafas-rest-api'
const config = {
hostname: 'example.org',
name: 'my-hafas-rest-api',
homepage: 'https://github.com/someone/my-hafas-rest-api',
version: '1.0.0',
aboutPage: false
}
const hafas = createHafas(dbProfile, 'my-hafas-rest-api')
const api = await createApi(hafas, config)
api.listen(3000, (err) => {
if (err) console.error(err)
})
config
keyskey | description | mandatory? | default value |
---|---|---|---|
hostname | The public hostname of the API. | ✔︎ | – |
name | The name of the API. Used for the X-Powered-By header and the about page. | ✔︎ | – |
description | Used for the about page. | ✔︎ (with aboutPage: true ) | – |
docsLink | Used for the about page. | ✔︎ (with aboutPage: true ) | – |
cors | Enable CORS? | ✗ | true |
etags | Express config for ETag headers | ✗ | weak |
handleErrors | Handle errors by sending 5** codes and JSON. | ✗ | true |
logging | Log requests using pino ? | ✗ | false |
healthCheck | A function that returning Promises that resolve with true (for healthy) or false . | ✗ | – |
version | Used for the X-Powered-By and X-API-Version headers. | ✗ | – |
homepage | Used for the X-Powered-By header. | ✗ | – |
aboutPage | Enable the about page on GET / ? | ✗ | true |
openapiSpec | Generate and serve an OpenAPI spec of the API? | ✗ | false |
addHafasOpts | Computes additional hafas-client opts. (opt, hafasClientMethod, httpReq) => additionaOpts | ✗ | – |
modifyRoutes | Extend or modify the default routes. | ✗ | routes => routes |
Pro Tip: Use hafas-client-health-check
for config.healthCheck
.
If you have a question or have difficulties using hafas-rest-api
, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.
FAQs
Expose a HAFAS client via an HTTP REST API.
The npm package hafas-rest-api receives a total of 8 weekly downloads. As such, hafas-rest-api popularity was classified as not popular.
We found that hafas-rest-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.