web-dev-qa-db-ja.com

既存の郵便配達員に基づいてswaggerを生成するにはどうすればよいですか？

REST API。開発中にAPIの使用と文書化にpostman（chrome拡張機能）を使用しました。素晴らしいツールで、ほとんどのエンドポイントが含まれています。リリースこのAPIをswaggerでドキュメント化したいのですが、どうすればよいですか？postmanエクスポートに基づいてswaggerを生成する方法はありますか？

swaggerswagger-uipostmanswagger-2.0
50
StuBob

誰かがこのリンクを投稿しました（そして削除しましたか？）： http://restunited.com/

郵便配達人のJSONを受け入れ、それをswaggerに変換します。これは私が探していたもののようです。

9
StuBob

APIMatic API Transformer は、Postmanコレクション（v1またはv2）を入力形式として処理し、Swagger 1.2または2.0を生成し、現在は出力としてOpenAPI 3.0.0を生成できます。

独自のAPIとWebフロントエンド、および コマンドラインバージョン もあります。

55
MikeRalphson

コードで https://github.com/stoplightio/api-spec-converter を使用できます

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);
    });
});
8
plotnik