API Style Guides

Heroku Platform API Design Conventions

Heroku's design conventions for the Platform API, documented in the Platform API Reference and the API Compatibility Policy. Notable for versioned media types (application/vnd.heroku+json; version=3), JSON Schema discovery via /schema, Range-based pagination, stability levels (prototype / development / production), and structured error payloads.

GitHub

Schemas & Data

📊
JSONSchema
https://api.heroku.com/schema

Other Resources

🔗
StyleGuide
https://devcenter.heroku.com/articles/platform-api-reference
🔗
CompatibilityPolicy
https://devcenter.heroku.com/articles/api-compatibility-policy
🔗
Scope

API entry from apis.yml

apis.yml Raw ↑ 
aid: style-guides:heroku
name: Heroku Platform API Design Conventions
description: Heroku's design conventions for the Platform API, documented in the Platform API Reference
  and the API Compatibility Policy. Notable for versioned media types (application/vnd.heroku+json; version=3),
  JSON Schema discovery via /schema, Range-based pagination, stability levels (prototype / development
  / production), and structured error payloads.
humanURL: https://devcenter.heroku.com/articles/platform-api-reference
baseURL: https://api.heroku.com
tags:
- REST
- Heroku
- JSON Schema
- Stability Levels
properties:
- type: StyleGuide
  url: https://devcenter.heroku.com/articles/platform-api-reference
- type: CompatibilityPolicy
  url: https://devcenter.heroku.com/articles/api-compatibility-policy
- type: JSONSchema
  url: https://api.heroku.com/schema
- type: Scope
  data:
    surfaces:
    - REST
    publisher: Heroku (Salesforce)
    license: documentation under Heroku terms
    status: living