The QR Code Generation API is a powerful and flexible solution for generating QR codes from text input. Built with TypeScript and Node.js, this API supports various output formats, including base64-encoded images, image files, streams, and embedded HTML. Comprehensive error handling ensures a smooth user experience, while Swagger documentation provides an easy-to-use interface for developers.
- QR Code Generation: Generate QR codes from user-provided text.
- Multiple Output Formats: Support for base64-encoded images, downloadable image files, and streams.
- HTML Response: Option to return an HTML page with the embedded QR code image.
- Error Handling: Comprehensive error handling to ensure a seamless user experience and provide clear, informative error messages.
- Swagger Documentation: Easy-to-use API documentation available at
/api-docs.
- TypeScript: For enhanced type safety and better developer experience.
- Node.js: For building the server-side application.
- Express.js: For managing routing and middleware.
- QRCode: For generating QR codes.
- Swagger: For documenting the API endpoints.
- Nodemon: For automatically restarting the server during development.
- Node.js
- npm (Node Package Manager)
- TypeScript
-
Clone the repository:
git clone https://github.com/stephen-lakes/qrcode-api.git
-
Change directory:
cd qr-code-api -
Install depencencies:
npm Install
-
Run the application
npm run dev