FroggerAPI Docs

Full Documentation & Samples

Looking for Postman collections, CI examples, or detailed workflow guidance?

Open full documentation →

Have questions about scope or expectations? Read the FAQ →

This page covers how to use FroggerAPI from the web UI, from scripts, and from CI/CD, along with key concepts and links to related guides.

Overview

FroggerAPI focuses exclusively on OpenAPI correctness, hardening, and enforcement before security scanning.

• Web UI at froggerapi.io for one-off conversions.
• Public API at https://froggerapi.io/api/convert for automation.
• Output: OpenAPI 3 JSON (YAML available via the UI for now).

Using the web UI

1. Go to froggerapi.io/convert.
2. Select your Postman collection JSON.
3. Optionally select a Postman environment JSON.
4. Click Convert to OpenAPI.
5. Review and download the OpenAPI output.

API usage

The main API endpoint is:

POST https://froggerapi.io/api/convert

Multipart form-data fields:

• collection (required) – your Postman collection JSON file.
• environment (optional) – Postman environment JSON file.

Example:

curl -X POST "https://froggerapi.io/api/convert" \
  -F "collection=@your_collection.postman_collection.json" \
  -F "environment=@your_environment.json" \
  -o openapi.json

CI/CD examples

Bash script

#!/usr/bin/env bash
set -euo pipefail

COLLECTION="collections/my-api.postman_collection.json"
OUTPUT="openapi.json"

curl -X POST "https://froggerapi.io/api/convert" \
  -F "collection=@${COLLECTION}" \
  -o "${OUTPUT}"

echo "OpenAPI written to ${OUTPUT}"

GitHub Actions

name: Convert Postman to OpenAPI

on:
  push:
    paths:
      - "collections/**"

jobs:
  convert:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Convert collection via FroggerAPI
        run: |
          curl -X POST "https://froggerapi.io/api/convert" \
            -F "collection=@collections/my-api.postman_collection.json" \
            -o openapi.json

      - name: Upload OpenAPI spec
        uses: actions/upload-artifact@v3
        with:
          name: openapi
          path: openapi.json

PowerShell example

$collectionPath = "my-api.postman_collection.json"
$outputPath     = "openapi.json"

Invoke-WebRequest `
  -Method Post `
  -Uri "https://froggerapi.io/api/convert" `
  -Form @{ collection = Get-Item $collectionPath } `
  -OutFile $outputPath

Write-Host "OpenAPI written to $outputPath"

Using with Tenable WAS

For a detailed walkthrough of using FroggerAPI output inside Tenable Web Application Scanning, see the dedicated guide: Using FroggerAPI with Tenable WAS.

On-prem / private deployments

FroggerAPI is designed to run as a pair of containers (public API + converter sidecar) inside your environment. If you need a private or on-premise deployment, see: On-prem / private deployment options, or email feedback@froggerapi.io.