Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hirosystems/api-toolkit
API toolkit
https://github.com/hirosystems/api-toolkit
Last synced: 3 days ago
JSON representation
API toolkit
- Host: GitHub
- URL: https://github.com/hirosystems/api-toolkit
- Owner: hirosystems
- License: apache-2.0
- Created: 2023-03-24T04:17:12.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-10-31T16:48:15.000Z (13 days ago)
- Last Synced: 2024-11-03T10:04:17.024Z (10 days ago)
- Language: TypeScript
- Homepage:
- Size: 415 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
/ / ▶ API Toolkit
/ --- / A comprehensive collection of tools designed by Hiro to simplify common tasks in
/ / API development.
[](https://www.npmjs.org/package/@hirosystems/api-toolkit)
The API Toolkit Library is a comprehensive collection of tools designed by Hiro to simplify common
tasks in API development. This library provides functionalities for database management, application
shutdown handlers, migration helpers, server version management, etc. It aims to streamline the
development process and improve code quality by offering convenient and reusable modules.
## Installation
You can start by installing the API Toolkit Library using npm:
```
npm install @hirosystems/api-toolkit
```
You should also customize the following ENV variables that control how log messages are displayed:
```env
APPLICATION_NAME=your-api-name
LOG_LEVEL=info
```
## Featured tools
Please see each tool's source directory for additional documentation
### Postgres
* Superclass for connection support and SQL transaction management using
[postgres.js](https://github.com/porsager/postgres)
* Connection helpers with automatic retry logic, using the standard postgres ENV variables
* Migration tools for migration apply and rollback using
[node-pg-migrate](https://github.com/salsita/node-pg-migrate)
* Type definitions and conversion helpers for postgres to node type management and viceversa
### Shutdown handlers
* Node.js signal handlers that provide a way to shut down long-running application components
gracefully on unhandled exceptions or interrupt signals.
### CPU Profiler
* Fastify server that controls a profiler capable of generating:
* `.cpuprofile` files for CPU usage analysis
* `.heapsnapshot` files for memory usage analysis
### Logger
* Standardized logger configuration using [pino](https://github.com/pinojs/pino)
### Server versioning
* `api-toolkit-git-info` executable tool to generate API versioning information based on Git branch,
tag, and latest commit
* Helpers to extract version info to display at runtime or on documentation
### Fastify
* API server creation with CORS, Typebox and Pino logging
* OpenAPI generator plugin with YAML and JSON exports
### Helpers
* Value conversion functions (hex strings, hashes, etc.)
* Timer tools (stopwatch, waiters, etc.)
## License
The API Toolkit Library is released under the Apache 2.0 License. See the LICENSE file for more
details.