Equation

Appearance

Getting Started with Equation for Developers ​

This section is for product teams who want to expose calculation logic as APIs within the Equation platform. It provides practical guidance on:

  • Exposing OpenAPI specifications
  • Deploying securely using Terraform
  • Applying platform-aligned policies (authentication, CORS, rate limiting)

INFO

📌 Equation follows a federated model, meaning each product team is responsible for developing and maintaining their own APIs, while the platform ensures consistency and governance.

📌 Note on API Development ​

These docs assume you already have:

  • A validated calculation package or backend service
  • A working API layer using frameworks such as FastAPI, Django, ASP.NET Core, Express.js, or similar

We do not cover how to build or structure your API application itself — including setting up HTTP routes, serializing inputs/outputs, or defining error handling.

Language & Framework Choice: While many teams use Python, the Equation platform supports APIs built in any language or framework that can expose an OpenAPI specification.

Teams starting from scratch should consult their tech lead or use internally approved templates for API services.

🧱 What You'll Learn ​

  • How to integrate an existing API into the Equation platform
  • How to define an OpenAPI specification and make it discoverable
  • How to deploy your API through Terraform pipelines using scoped managed identities
  • How to apply standard security and operational policies
  • How to ensure your API appears in the central API Inventory

🧭 Start Here ​

  1. Add an API to API Management Use your scoped identity and standard templates to deploy your API

  2. Define OpenAPI Specifications Create and publish OpenAPI specs for discoverability)

  3. API Policies Apply authentication, rate limiting, and other controls

  4. Inventory Visibility Ensure your API is discoverable in the central API Inventory