Veil - Documentation

info

These docs are still a WIP, please open an issue ticket if you see any discrepancies.

Overview

Veil is an opinionated, fully featured, modular observability stack for APIs. Allows you to sell, monitor, authenticate your APIs.

The veil API marketplace platform enables API providers to publish their APIs and allows consumers to discover, subscribe to, and manage API access through a unified gateway. This documentation covers the platform architecture, specifications, and development guides.

Core Components

1. Gateway Layer (Caddy-based)

This component is also called the core of caddy by maintainers. This is a modded caddy build with first class support for observability and API validation validation for non standard properties like API keys, granular rate limits, etc.

2. Platform Services

The Veil marketplace platform is a SaaS built using Veil and offered by TheFlyWheel where developers can come and host their APIs and get them behind a paywell very easily.

Architecture

1. Design

   • Architecture Overview
   • System Components
   • Data Flow

2. Key Features

   • Versioned API configurations
   • Log-based analytics
   • Hybrid consistency model
   • Multi-region deployment
   • High availability design

3. Technology Stack

   • Gateway Layer
     • Go & Caddy for core services
     • SQLite for data storage (v1)
   • Platform Services
     • FusionAuth for authentication
     • S3-compatible config storage (WIP)

Contributing

1. Development Guidelines

   • Development Setup
   • Code Style
   • Git Workflow
   • Testing Requirements

2. Documentation

   • Architecture Design Document
   • API Desing Document
   • OpenAPI Swagger Reference for implemented APIs

Support

• Issue Tracking
• Release Notes

License

Veil is licensed under the MIT License.