Developer’s Guide

Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.

• API Guidelines
  • Response Bodies
  • HTTP Request Methods
  • HTTP Response Codes
  • Documentation
  • Passing Request Data
  • Duplicate Endpoints
  • Date/Time Format
  • Age Filtering
  • Tenancy
  • Naming Conventions
  • Relationships as Objects
  • Change Logging
• Environment Variables
• Building Traffic Control
  • Downloading Traffic Control
  • Build Using pkg
  • Build the RPMs Natively
  • Building Individual Components
• Debugging inside CDN-in-a-Box
  • Enroller
  • t3c on Caches
  • Traffic Monitor
  • Traffic Ops
  • Traffic Router
  • Traffic Stats
  • Troubleshooting
• Documentation Guidelines
  • Building
  • Writing
• Godocs
  • Linking to Godocs
  • Keeping pkg.go.dev from hiding the Apache Traffic Control Godocs
• Traffic Monitor
  • Introduction
  • Software Requirements
  • Project Tree Overview
  • Architecture
  • Formatting Conventions
  • Installing The Developer Environment
  • Test Cases
  • API
• Traffic Ops
  • Introduction
  • Software Requirements
  • Traffic Ops Project Tree Overview
  • app/db/admin
  • Installing The Developer Environment
  • app/db/traffic_vault_migrate
  • Test Cases
  • Writing New Endpoints
  • Extensions
• Traffic Portal
  • Introduction
  • Software Requirements
  • Traffic Portal Project Tree Overview
  • Installing The Traffic Portal Developer Environment
• Traffic Router
  • Introduction
  • Software Requirements
  • Traffic Router Project Tree Overview
  • Java Formatting Conventions
  • Installing The Developer Environment
  • Manual Testing
  • Test Cases
  • RPM Packaging
  • API
• Traffic Stats
  • Introduction
  • Software Requirements
  • Traffic Stats Project Tree Overview
  • Go Formatting Conventions
  • Installing The Developer Environment