@gyeonghokim/openapi-converter

v1.1.0

Published

11 hours ago

Convert API collection files (Postman, Apidog, Bruno) to OpenAPI v3 format

Downloads

185

0High
0Medium
0Low

gyeonghokim

openapi postman apidog bruno converter cli

openapi-converter

Convert API collection files (Postman, Apidog, Bruno) to OpenAPI v3 format.

Features

Convert Postman Collections to OpenAPI v3
Convert Apidog Collections to OpenAPI v3
Convert Bruno Collections to OpenAPI v3

Installation

npm install -g @gyeonghokim/openapi-converter

Or use locally:

npm install --save-dev @gyeonghokim/openapi-converter

Usage

openapi-converter <input-file> [options]
# or just
oac <input-file> [options]

Options:
  -o, --output <path>       Output file path (default: openapi.json, only supports json and yaml formats)
  -p, --provider <provider> Provider to use (default: postman, only supports postman, apidog, bruno)
  -h, --help                Show help message

Examples

# Convert Postman collection
openapi-converter collection.json -o api-spec.json

# Convert Apidog collection
openapi-converter apidog-export.json

# Convert Bruno collection
openapi-converter bruno-collection.json -o openapi.yaml

Development

Setup

# Clone the repository
git clone <repository-url>
cd openapi-converter

# Install dependencies
npm install

Available Scripts

# Build the project
npm run build

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with UI
npm run test:ui

# Run linter
npm run lint

# Format code
npm run format

# Check and fix formatting and linting
npm run check

# Development mode (watch)
npm run dev

Project Structure

openapi-converter/
├── src/
│   ├── cli.ts           # CLI entry point
│   └── index.ts         # Main conversion logic
├── test/
│   └── index.test.ts    # Tests
├── dist/                # Build output (generated)
├── biome.json           # Biome configuration
├── tsconfig.json        # TypeScript configuration
├── commitlint.config.js # Commitlint configuration
└── package.json         # Project configuration

Git Hooks

This project uses Husky for Git hooks:

pre-commit: Runs lint-staged to check and format staged files
commit-msg: Validates commit messages against conventional commit format

Commit Message Format

This project follows Conventional Commits:

<type>(<scope>): <subject>

<body>

<footer>

Types:

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code style changes (formatting, etc.)
refactor: Code refactoring
perf: Performance improvements
test: Adding or updating tests
build: Build system changes
ci: CI configuration changes
chore: Other changes

License

MIT