How can I generate swagger based off of existing postman collection?

Question

I am developing a REST API. during development I have used postman (chrome extension) to use and document my API. It is a wonderful tool and I have most of my API endpoints in it. However, as we near release I would like to document this API in swagger, how would I do that? Is there a way that I can generate swagger based off of the postman export?

For C#/DotNet, see these two: 1.[]c# - How to generate JSON Postman Collections from a WebApi2 project using WebApi HelpPages that are suitable for import - Stack Overflow ; ; stackoverflow.com/questions/23158379/ ; ; ; 2.[]; ; X.Introducing the Azure API Apps Tools for Visual Studio 2013 - The Visual Studio Blog - Site Home - MSDN Blogs ; ; http://blogs.msdn.com/b/visualstudio/archive/2015/03/24/introducing-the-azure-api-apps-tools-for-visual-studio-2013.aspx — AnneTheAgile, Dec 23 '15 at 03:46
You can use postman2openapi on the web: https://kevinswiber.github.io/postman2openapi/ — Arlemi, Apr 07 '21 at 14:22

score 92 · Answer 1 · edited Jul 03 '19 at 14:54

92

APIMatic API Transformer can process a Postman collection (v1 or v2) as an input format and produce Swagger 1.2 or 2.0, and now OpenAPI 3.0.0 as output.

It has its own API and a Web front-end, and also a command-line version.

edited Jul 03 '19 at 14:54

Helen

58,317
8
161
218

answered Mar 15 '16 at 06:28

MikeRalphson

1,751
1
12
13

8

Note that the site requires an account to be created to use. – ryanwebjackson Mar 01 '19 at 19:31
now supports swagger 2.1 – OzBob Oct 29 '19 at 04:02
This works like a charm when I tried to convert my postman V2.1 json to swagger 2.0. But they ask you to sign up first. – Sathish Nov 22 '19 at 10:30
I have signed up and they have provided me a 14 days trial period, not sure if I would be able to convert the Postman collection to Swagger post the trial period is over. – Rito Jan 25 '21 at 05:22

score 16 · Accepted Answer · answered Jul 13 '15 at 15:23

16

Someone posted this link (and deleted it?): http://restunited.com/

It accepts postman JSON and converts it to swagger. This seems to be what I was looking for.

answered Jul 13 '15 at 15:23

StuBob

1,192
1
8
13

4

RestUnited is only free if one has <=5 endpoints per API and <=3 APIs. – AnneTheAgile Dec 22 '15 at 18:35
The export (to postman collection or swagger spec) has no limitation. The limitation you mentioned is only for generating SDKs and documentation. – William Cheng Aug 12 '16 at 13:18
5

The best option for the OP is https://apimatic.io/transformer – Waseem Hassan Oct 24 '16 at 04:35
1

I just tried to import the default postman echo collection on restunited and it wouldn't work. Maybe they haven't been keeping up to date with postman? – daraul Apr 21 '18 at 16:07
1

it doesn't work for new versions. – parisssss Jun 09 '18 at 10:40
Not able to find the upload postman collection option, maybe they have stopped the support. – Rito Jan 19 '21 at 11:48

score 14 · Answer 3 · answered Mar 19 '18 at 15:48

You can use https://github.com/stoplightio/api-spec-converter with code

var transformer = require('api-spec-transformer');

var postmanToSwagger = new transformer.Converter(transformer.Formats.POSTMAN, transformer.Formats.SWAGGER);

postmanToSwagger.loadFile('/path/to/your.json.postman_collection', function(err) {
  if (err) {
    console.log(err.stack);
    return;
  }

  postmanToSwagger.convert('yaml')
    .then(function(convertedData) {
      // convertedData is swagger YAML string
      console.log(convertedData);
    })
    .catch(function(err){
      console.log(err);
    });
});

This only works with Postman V1 collections though! – Lukas Knuth May 22 '18 at 14:31 — Lukas Knuth, May 22 '18 at 14:31

How can I generate swagger based off of existing postman collection?

3 Answers3

Linked