Documentation

Developer Docs_

Comprehensive documentation, API references, tutorials, and guides to help you build powerful integrations with Pocat Gateway.

Documentation

Documentation Categories

Find the information you need to get started, integrate systems, and deploy production-ready solutions.

Getting Started
Quick start guides, installation instructions, and basic configuration examples.
  • Installation Guide
  • First Integration
  • Basic Configuration
  • Hello World Example
API Reference
Complete API documentation with endpoints, parameters, and response examples.
  • REST API Endpoints
  • Authentication Methods
  • Request/Response Schemas
  • Error Codes & Handling
Configuration
Detailed configuration guides for all gateway components and features.
  • Gateway Configuration
  • Routing Rules
  • Filter Chains
  • Environment Variables
Documentation Sections

Explore Documentation

Browse through our comprehensive documentation organized by topics and use cases.

Quick Start Guide

Get up and running with Pocat Gateway in under 10 minutes with our step-by-step quick start guide.

1
Installation
Install Pocat Gateway using Docker or native packages
2
Configuration
Create your first gateway configuration file
3
First Route
Set up your first API route and test it
4
Deploy
Deploy to production environment
# Quick Start Commands
# 1. Install Pocat Gateway
docker pull pocat/gateway:latest
# 2. Create configuration
mkdir pocat-config
cat > pocat-config/gateway.yaml << EOF
server:
port: 8080
routes:
- path: "/api/*"
backend: "http://backend:3000"
EOF
# 3. Start gateway
docker run -p 8080:8080 \
-v ./pocat-config:/etc/pocat \
pocat/gateway:latest
# 4. Test your first route
curl http://localhost:8080/api/health
Resources

Additional Resources

Explore additional resources including tutorials, community content, and developer tools.

CLI Documentation
Complete command-line interface reference with examples and usage patterns.
GitHub Repository
Access source code, examples, and contribute to the Pocat Gateway project.
SDK Documentation
Language-specific SDKs and libraries for Java, Python, Node.js, and .NET.
Downloads
Download binaries, Docker images, and installation packages for all platforms.
Community Forum
Join the community, ask questions, and share your integration experiences.
Video Tutorials
Step-by-step video guides for common integration scenarios and advanced features.
Get Started

Ready to Build?

Start building with Pocat Gateway today using our comprehensive documentation and examples.