API Documentation

Complete OpenAPI 3.0 specification for the Password Generator API. Generate secure passwords with multiple algorithms, manage wordlists dynamically, and support international languages.

Base URL: http://localhost:8080/api/v1

🔐 Multiple Algorithms

High-entropy, XKCD, Diceware, PWGen, and Passkey generation methods

🌍 Internationalization

Dynamic wordlist discovery and multi-language UI support

📊 Entropy Analysis

Real-time password strength calculation and security metrics

🔧 Configurable

Extensive customization options for all password types

Download Configuration Files

Get the complete API specification in various formats for integration with your tools and workflows.

📄 OpenAPI JSON

Complete OpenAPI 3.0 specification in JSON format. Perfect for code generation, API testing, and integration with development tools.

Download JSON

📋 OpenAPI YAML

Human-readable YAML format specification. Ideal for documentation, version control, and collaborative API development.

Download YAML

🚀 Postman Collection

Ready-to-use Postman collection with all endpoints, examples, and environment variables for immediate API testing.

Download Collection

⚡ cURL Examples

Complete set of cURL commands with examples for all endpoints. Perfect for command-line testing and scripting.

Download Examples

Interactive API Explorer

Quick Start

Get started with the Password Generator API in minutes. Here are some common examples:

Generate XKCD Passphrase

curl -X POST "http://localhost:8080/api/v1/passwords/generate" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "xkcdpass",
    "count": 3,
    "options": {
      "words": 4,
      "wordlist": "en",
      "separator": "-",
      "add_number": true,
      "number_position": "random"
    }
  }'

Check Available Wordlists

curl -X GET "http://localhost:8080/api/v1/passwords/wordlists"

Generate High-Entropy Password

curl -X POST "http://localhost:8080/api/v1/passwords/generate" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "high-entropy",
    "count": 1,
    "options": {
      "length": 20,
      "include_symbols": true
    }
  }'