Gateway लायब्ररीसह Node.js वापरून API तयार करणे Express आणि Swagger API दस्तऐवजीकरणासाठी एकत्रीकरण खालीलप्रमाणे केले जाऊ शकते:
पायरी 1: प्रकल्प सेट करा आणि लायब्ररी स्थापित करा
- तुमच्या प्रकल्पासाठी नवीन निर्देशिका तयार करा.
- उघडा Command Prompt किंवा Terminal प्रकल्प निर्देशिका वर नेव्हिगेट करा:
cd path_to_directory. - एनपीएम पॅकेज सुरू करा:
npm init -y. - आवश्यक लायब्ररी स्थापित करा:.
npm install express ocelot swagger-ui-express
पायरी 2: कॉन्फिगर Express आणि Ocelot
app.js प्रोजेक्ट डिरेक्टरीमध्ये नावाची फाइल तयार करा आणि कॉन्फिगर करण्यासाठी ती उघडा Express:
const express = require('express');
const app = express();
const port = 3000;
// Define routes here
app.listen(port,() => {
console.log(`API Gateway is running at http://localhost:${port}`);
});
ocelot-config.json तुमची विनंती राउटिंग परिभाषित करण्यासाठी नावाची कॉन्फिगरेशन फाइल तयार करा:
{
"Routes": [
{
"DownstreamPathTemplate": "/service1/{everything}",
"DownstreamScheme": "http",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/api/service1/{everything}",
"UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]
}
// Add other routes here
]
}
पायरी 3: समाकलित करा Swagger
फाइलमध्ये app.js, समाकलित करण्यासाठी खालील कोड जोडा Swagger:
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json'); // Create a swagger.json file
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
swagger.json प्रकल्प निर्देशिकेत नावाची फाइल तयार करा आणि API दस्तऐवजीकरण माहिती परिभाषित करा:
{
"swagger": "2.0",
"info": {
"title": "API Gateway",
"version": "1.0.0"
},
"paths": {
"/api/service1/{everything}": {
"get": {
"summary": "Get data from Service 1",
"responses": {
"200": {
"description": "Successful response"
}
}
}
}
// Add definitions for other APIs here
}
}
पायरी 4: प्रकल्प चालवा
उघडा Command Prompt किंवा Terminal प्रकल्प निर्देशिकेवर नेव्हिगेट करा.
कमांडसह प्रकल्प चालवा: node app.js.
पायरी 5: Swagger UI मध्ये प्रवेश करा
Swagger पत्त्यावर UI मध्ये प्रवेश करा: http://localhost:3000/api-docs.
कृपया लक्षात घ्या की एपीआय कसे उपयोजित करायचे Gateway आणि Swagger Node.js वापरून एकत्रीकरण कसे करायचे याचे हे एक साधे उदाहरण आहे. व्यवहारात, तुम्ही सुरक्षा, आवृत्ती, सानुकूल कॉन्फिगरेशन आणि इतर बाबींचा विचार केला पाहिजे.