Guide

This guide covers all aspects of building APIs with Apiwork — from installation to advanced features.

Getting Started

New to Apiwork? Start here:

1. Introduction — what Apiwork is and how it works
2. Installation — add Apiwork to a Rails app
3. Core Concepts — how the pieces fit together
4. Quick Start — build a working API in minutes

Core

Once the basics are covered, explore each concept in depth:

• API Definitions — declare resources, exports, and configuration
• Contracts — define what requests accept and responses return
• Representations — connect contracts to ActiveRecord models
• Types — objects, unions, enums, and custom types
• Controllers — expose data, access contracts, pass context
• Introspection — inspect API structure programmatically
• Adapters — filtering, sorting, pagination, and nested writes
• Exports — generate OpenAPI, TypeScript, and Zod from the definitions
• Errors — structured error handling across the boundary