Documentation Overview¶
Comprehensive documentation for the Apiary framework.
Documentation Structure¶
Getting Started¶
Learn the basics and get Apiary running:
- Installation - Install and configure Apiary
- Quick Start - Build your first endpoint in minutes
- Configuration - Configure settings and endpoints
User Guide¶
Master Apiary's features:
- Overview - Architecture and concepts
- Adding Endpoints - Code-based and config-based endpoints
- Advanced Endpoints - Advanced endpoint features
- Creating Services - Build business logic services
- Authentication - Implement API key auth
- API Key Validation - Validate API key configurations
- API Key Examples - API key usage examples
- Advanced Configuration - Advanced configuration options
- Built-in Endpoints - Health, metrics, and discovery
Deployment¶
Deploy Apiary to production:
- Overview - Deployment strategies
- Updating - Update your deployment safely
- Server Setup - Configure servers
- Configuration - Production settings
- Monitoring - Monitor your API
Reference¶
API and configuration reference:
- Quick Reference - Quick lookup guide
- CLI Reference - Command-line tools
- Core Modules - Core framework APIs
- Services - Service base classes
- Models - Request/response models
- Configuration Options - All config options
- Project Structure - Understand the codebase
About¶
Project information:
- Overview - This page
- Changelog - Version history
- Contributing - Contribution guidelines
- License - MIT License
Contributing to Docs¶
Documentation improvements welcome! Edit Markdown files in the docs/ directory and submit a PR.
See Contributing Guide for details.
Feedback¶
Found an issue or have a suggestion?
Documentation built with MkDocs Material