Swaggy-Swagger-Node

Overview

Swaggy UI is a javascript project intended for use in single-page applications that to enhance the user interface of the Swaggy-Swagger library. Swaggy-Swagger builds upon the popular Swagger framework, providing a more intuitive and flexible API documentation experience.

See Swaggy-Swagger README.md for more details.

Demo Website

swaggy-swagger.vercel.app

Demo Video

Swaggy-Swagger-Node is a customized version of Swagger UI tailored specifically for Node.js users. This npm package enhances API documentation experiences by building upon the original Swagger UI framework, offering a more intuitive and flexible interface for Node.js applications. The UI closely follows the original Swagger UI design, ensuring a familiar look and feel for users.

For more information on the original Swagger UI project, please visit the official Swagger UI repository.

How To Install

To install Swaggy-Swagger-Node in your Node.js project, follow these steps.

1. Install the package

Use npm to install swaggy-swagger:

npm install swaggy-swagger

2. Set up Express and Swagger

Create an app.ts file (or app.js if you're using JavaScript) and set up your Express server. Use the setupSwagger function from swaggy-swagger to integrate Swagger UI.

import express, { Request, Response } from 'express';
import { setupSwagger } from 'swaggy-swagger';

const app = express();
const host = 'localhost';
const port = 3000;

// Apply Swagger settings
setupSwagger(app, host, port);

// Add a sample API endpoint
/**
 * @swagger
 * /test:
 *   get:
 *     summary: Test API
 *     description: A simple test API endpoint
 *     responses:
 *       200:
 *         description: Returns a sample message
 *         content:
 *           application/json:
 *             schema:
 *               type: object
 *               properties:
 *                 message:
 *                   type: string
 *                   example: "Hello, this is a test API!"
 */
app.get('/test', (req: Request, res: Response) => {
	res.json({ message: 'Hello, this is a test API!' });
});

// Start the server
app.listen(port, () => {
	console.log(`Server is running at http://${host}:${port}`);
	console.log(`Swagger UI available at http://${host}:${port}/swagger`);
});

3. Run the Application

• If you're using TypeScript, you can run the file directly with ts-node:

npx ts-node src/app.ts

• If you're using JavaScript, start the server with Node.js:

node src/app.js

Contact