zap-converters

The converters package is responsible for converting collections from one format to a Zap collection. It can be used as a standalone package or as a part of the Zap framework.

Installation

npm install @usezap/converters

Usage

Convert Postman collection to Zap collection

const { postmanToZap } = require('@usezap/converters');

// Convert Postman collection to Zap collection
const zapCollection = postmanToZap(postmanCollection);

Convert Postman Environment to Zap Environment

const { postmanToZapEnvironment } = require('@usezap/converters');

const zapEnvironment = postmanToZapEnvironment(postmanEnvironment);

Convert Insomnia collection to Zap collection

import { insomniaToZap } from '@usezap/converters';

const zapCollection = insomniaToZap(insomniaCollection);

Convert OpenAPI specification to Zap collection

import { openApiToZap } from '@usezap/converters';

const zapCollection = openApiToZap(openApiSpecification);

Example

const { postmanToZap } = require('@usezap/converters');
const fs = require('fs/promises');
const path = require('path');

async function convertPostmanToZap(inputFile, outputFile) {
  try {
    // Read Postman collection file
    const inputData = await fs.readFile(inputFile, 'utf8');
    
    // Convert to Zap collection
    const zapCollection = postmanToZap(JSON.parse(inputData));
    
    // Save Zap collection
    await fs.writeFile(outputFile, JSON.stringify(zapCollection, null, 2));
    
    console.log('Conversion successful!');
  } catch (error) {
    console.error('Error during conversion:', error);
  }
}

// Usage
const inputFilePath = path.resolve(__dirname, 'demo_collection.postman_collection.json');
const outputFilePath = path.resolve(__dirname, 'zap-collection.json');

convertPostmanToZap(inputFilePath, outputFilePath);