expressjs swagger yaml
- Install Express.js: To use Express.js in your project, you need to install it first. Use the package manager npm (Node Package Manager) to install Express.js by running the following command in your terminal:
npm install express
- Create an Express.js application: Once Express.js is installed, you can create an application by creating a new JavaScript file and requiring the Express module. Here's an example:
const express = require('express');
const app = express();
- Define routes: In Express.js, you can define routes to handle different HTTP requests. For example, you can define a route to handle GET requests to the root URL ("/") like this:
app.get('/', function (req, res) {
res.send('Hello World!');
});
- Start the server:
To start the Express.js server and make it listen for incoming requests, use the
listen
method. Specify the port number you want the server to listen on. Here's an example:
app.listen(3000, function () {
console.log('Server listening on port 3000!');
});
- Add Swagger UI:
Swagger UI is a popular tool for documenting and testing APIs. To add Swagger UI to your Express.js application, you need to install the
swagger-ui-express
package. Use the following command to install it:
npm install swagger-ui-express
- Create a Swagger YAML file: Create a YAML file to define your API documentation using the Swagger specification. This file will contain information about your API's endpoints, request and response models, and more. Here's an example of a simple Swagger YAML file:
openapi: 3.0.0
info:
title: My API
version: 1.0.0
paths:
/hello:
get:
summary: Get a greeting
responses:
'200':
description: A successful response
content:
application/json:
schema:
type: object
properties:
message:
type: string
- Serve the Swagger UI:
To serve the Swagger UI in your Express.js application, import the
swaggerUi
module fromswagger-ui-express
and add a route to serve the Swagger UI HTML page. Here's an example:
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.yaml');
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
That's it! Now you have an Express.js application with Swagger UI integrated. You can access the Swagger UI by visiting the /api-docs
URL in your browser. From there, you can explore and test your API endpoints.