Postman Collection APIs to Swagger Docs

-

Being an back-end developer we generally works with APIs, for storing the APIs mostly developers are using the Postman, So in this blog will discuss how to covert postman collection APIs to swagger APIs documentation.

Express Js Project Convert Postman Collection APIs to Swagger Docs


Postman APIs Docs by Education Funda

Postman to Swagger Docs

Swagger-APIs by Education Funda


Step 1: You should have proper APIs postman collection for your project.

Step 2: Install swagger ui in your node project via ~ npm i swagger-ui-express.

Step 3: Put below code in your Routes index file OR app.js wherever you maintained your express routes as per your requirements:

Here you also need to create 1 json file for storing the details of your APIs docs just like we create swagger-output.json.

import express from "express";
import swaggerUi from "swagger-ui-express";

const swaggerDocument = JSON.parse(
await readFile(new URL("../../../../swagger-output.json", import.meta.url))
);

const router = express.Router();

// adding swagger docs routing
router.use("/docs", swaggerUi.serve);
router.get("/docs", swaggerUi.setup(swaggerDocument));

// routings
// ...

export default router;

Step 4: Now export your postman APIs collection in the json format.

Step 5: Go to website https://metamug.com/util/postman-to-swagger/.

Step 6: After converting your postman APIs collection to Swagger (Open API), and convert it into JSON format on any online YAML to JSON converter website then just copy all the JSON formatted code and paste in your swagger-output.json file.

Step 7: Now open http://localhost:[post]/docs, your docs will open with all the APIs which you stored in your postman collection. just like below:



That's it!
Congrats you reached the end of the document.

Check Author's Github Profile

<>Happy Coding</> 💻

Follow me here 💛


Location: Delhi, India

Comments

Post a Comment

Popular posts from this blog

JavaScript Logical Output Based Interview Questions

-
Image
You mostly seen in JavaScript interviews there interviewers must asks output based questions in which candidate stuck mostly so here in this blog I'm telling you most commonly asked output based JavaScript interview questions. By Education Funda Most Commonly Asked JavaScript Output Based Questions Question: 1 function sum(){      let a = 8;      const b=2;      var c=a+b; } console.log(a) // Reference error: a is not defined console.log(b) // Reference error: a is not defined console.log(c) // Reference error: a is not defined sum() console.log(a) // Reference error: a is not defined console.log(b) // Reference error: b is not defined console.log(c) //Output: undefined ---------------------------------------------------------------------------- Question: 2 let arr=[1,2,3,4,5]; console.log(arr[2], arr.length); //Output: 3 5 arr.length=0; console.log(arr[2], arr.length); //Output: undefined 0 Note:  As we can see in above code 1st questions is so easy but second is bit tricky one
Read more

Create and Deploy AWS SAM Application

-
Image
How To Create and Deploy Your First Lambda Function on AWS Serverless Application Modal AWS SAM - Education Funda Create Your SAM Application Software Requirements: AWS CLI ( Reference Link ) SAM CLI ( Reference Link ) Docker ( Reference Link ) AWS Serverless Architecture - Education Funda Now All Will Happen With Command Line Interface Now open Terminal and Go to your directory in which you want to create your project. $ sam init  #hit enter this command ~ This will appear 2 option, 1 AWS Quick Start and 2 Custom Template For making things simple you can 1 at moment. ~ Now you need to select template, at moment you can select Hello World Example. ~ Now it will ask for programming language Python by default and you can select other as well such as Node.js, Java, etc. ~ Now you can choose ZIP option. ~ Now it will ask starter template, you can select anyone from that Hello World Example. ~ X-Ray tracing you can enable so select Y. ~ Enable Cloud Watch now with select Y. ~ Now it ask
Read more

Deploy Angular Build With Express JS Project

-
Image
Deploy Angular Build in Node JS (Express JS) Server Mean Stack - Education Funda Firstly Create Angular Production Ready Build: ~ ng build (run in command line when directory is projectFolder). ~ Compress using Brotli compression the resources using the following command for i in dist/*/*; do brotli $i; done Deployment Check Angular Build: You can get a preview of your application using the ng serve --prod command that starts a local HTTP server such that the application with production files is accessible using http://localhost:4200. This is not safe to use for production usage. For a production usage, you have to deploy all the files from the dist folder in the HTTP server of your choice. Node JS/Express JS Server File Changes: //enabling CORS app . use ( cors ()); app . use ( express . static ( path . resolve ( './public' ))); //api v1 base route set app . use ( '/api/v1' , router ); //angular front site app . use ( express . static ( path . resolve ( './public/a
Read more