AshOaskit

OpenAPI 3.0 and 3.1 specification generation for Ash Framework.

Installation | Quick Start | Livebooks | Configuration | API Reference | Phoenix Integration

Overview

AshOaskit derives OpenAPI documents from Ash resources and AshJsonApi routes. It can emit OpenAPI 3.0 and 3.1 from the same domain definitions.

Try It Interactively

The Livebook notebooks are executable guides, not extra API reference pages. Start with the quick-start notebook in a browser:

• Quick Start - Generate and validate a spec from a tiny AshJsonApi domain.
• Schema Generation - Learn public fields, constraints, nullable values, embedded resources, custom types, and input schemas.
• Routes and JSON:API - Inspect generated paths, operations, query parameters, and relationship endpoints.
• Serving, Customization, and Validation - Serve specs, add security/webhooks/extensions, export files, and validate with Oaskit.
• Architecture Deep Dive - Walk through the generator pipeline and extension points.

Background

This project was created to address the need for OpenAPI 3.1 specification support in the Ash ecosystem. AshJsonApi provides excellent JSON:API compliance and served as significant inspiration for this library's approach to introspecting Ash resources. However, it generates OpenAPI 3.0 specifications.

OpenAPI 3.1 brings full alignment with JSON Schema 2020-12, enabling:

• Type arrays for nullable fields (["string", "null"] instead of nullable: true)
• Better validation tooling compatibility
• Improved schema reuse patterns

This library complements AshJsonApi by reading its route configurations and generating modern OpenAPI specifications while maintaining backwards compatibility with 3.0 for teams that need it.

AshOaskit uses Oaskit to normalize generated specs and render ordered JSON. Generation checks local schema references; call AshOaskit.validate/1 for full OpenAPI validation.

Features

AshOaskit provides:

• Automatic Schema Extraction - Derives JSON Schema from Ash resource attributes
• AshJsonApi Integration - Builds paths from configured routes
• Dual Version Support - Generate 3.0 or 3.1 specs from the same codebase
• Spec Validation - Validate generated specs against the OpenAPI schema via Oaskit
• Phoenix Controller - Serve specs directly from your application
• CLI Generation - Generate static spec files for documentation

Feature Comparison

Installation

Requires Elixir 1.17+, Ash 3.33+, Spark 2.6+, Plug 1.20.3+, and Oaskit 0.14.2+. Optional integrations require AshJsonApi 1.7.1+, Phoenix 1.8.13+, and Igniter 0.6.29+. These minimums include the security fixes used by this library.

Ash 3.33 requires an explicit string-length policy in your application:

config :ash, default_string_length_count: :codepoints

Codepoints match JSON Schema's length semantics. Configure this in your application; dependencies cannot supply application-wide Ash settings.

Add ash_oaskit to your dependencies in mix.exs:

defp deps do
  [
    {:ash_oaskit, "~> 0.4.1"},
    # Optional: For YAML output
    {:ymlr, "~> 5.0", optional: true}
  ]
end

Quick Start

Define a Spec Module (Recommended)

defmodule MyAppWeb.ApiSpec do
  use AshOaskit,
    domains: [MyApp.Blog],
    title: "My API",
    api_version: "1.0.0"
end

Serve it (with a Redoc UI) from your Phoenix or Plug router:

use AshOaskit.Router,
  spec: MyAppWeb.ApiSpec,
  open_api: "/openapi",
  redoc: "/redoc"

The spec module implements the oaskit behaviour: the generated spec is cached in :persistent_term, served by Oaskit.SpecController, exportable with mix openapi.dump MyAppWeb.ApiSpec, and usable with Oaskit.Plugs.SpecProvider for request validation of hand-written controllers. See the Spec Modules guide.

Development {: .tip}

Add config :ash_oaskit, cache_specs: false to config/dev.exs so code reloads regenerate the spec.

Generate a Spec Programmatically

# OpenAPI 3.1 (default)
spec = AshOaskit.spec(domains: [MyApp.Blog], title: "My API")
#=> %{"openapi" => "3.1.0", "info" => %{"title" => "My API", ...}, ...}

# OpenAPI 3.0
spec = AshOaskit.spec_30(domains: [MyApp.Blog])
#=> %{"openapi" => "3.0.3", ...}

CLI Generation

# Export a spec module (preferred — uses the exact spec your app serves)
mix openapi.dump MyAppWeb.ApiSpec --pretty -o openapi.json

# Generate without a spec module
mix ash_oaskit.generate -d MyApp.Blog -o openapi.json

# Generate OpenAPI 3.0 spec
mix ash_oaskit.generate -d MyApp.Blog -v 3.0 -o openapi-3.0.json

# Generate YAML format (requires ymlr)
mix ash_oaskit.generate -d MyApp.Blog -f yaml -o openapi.yaml

Field Visibility

Specs include only fields marked public? true — the same set AshJsonApi serializes:

attributes do
  uuid_primary_key :id

  attribute :title, :string do
    public? true
  end

  # Not public: never appears in the generated spec
  attribute :internal_notes, :string
end

Configuration

Application Config

config :ash_oaskit,
  version: "3.1",           # Default OpenAPI version
  title: "My API",          # Default API title
  api_version: "1.0.0"      # Default API version

Spec Options

API Reference

Core Functions

# Generate spec with options
AshOaskit.spec(domains: [Domain], title: "API", api_version: "1.0")

# Version-specific shortcuts
AshOaskit.spec_30(domains: [Domain])  # Force 3.0
AshOaskit.spec_31(domains: [Domain])  # Force 3.1

Spec Validation

Generated specs can be validated against the OpenAPI schema:

spec = AshOaskit.spec(domains: [MyApp.Blog])

# Returns {:ok, %Oaskit.Spec.OpenAPI{}} or {:error, reason}
{:ok, validated} = AshOaskit.validate(spec)

# Raises on invalid specs
validated = AshOaskit.validate!(spec)

Type Mapping

See AshOaskit.TypeMapper for unions, structs, embedded resources, and custom types with a json_schema/1 callback. A declared callback must return a schema map; exceptions and malformed return values stop generation with the custom type and attribute in the error instead of emitting a guessed schema.

Component names come from each resource's JSON:API type, falling back to the resource module's final segment. If two resources resolve to the same name, generation fails with both modules and the conflicting component name. Give such resources distinct JSON:API types so $ref identity remains unambiguous.

Constraint Mapping

Router Integration

Works in both Phoenix Router and Plug.Router — the macro detects the router type:

defmodule MyAppWeb.Router do
  use MyAppWeb, :router

  use AshOaskit.Router,
    spec: MyAppWeb.ApiSpec,
    open_api: "/openapi",
    redoc: "/redoc"

  # Your other routes, pipelines, scopes, etc.
end

Generates:

• GET /openapi.json — the spec, served from cache (?pretty=1 to format)
• GET /redoc — Redoc UI

Serve OpenAPI 3.0 and 3.1 side by side with two spec modules:

use AshOaskit.Router,
  spec: [{"3.1", MyAppWeb.ApiSpecV31}, {"3.0", MyAppWeb.ApiSpecV30}],
  open_api: "/openapi"

# GET /openapi.json     -> 3.1 (first entry)
# GET /openapi/3.1.json -> 3.1
# GET /openapi/3.0.json -> 3.0

use AshOaskit.Router,
  domains: [MyApp.Blog, MyApp.Accounts],
  open_api: "/docs/openapi",
  title: "My API",
  version: "1.0.0"

AshJsonApi Integration

AshOaskit reads routes from domains using AshJsonApi.Domain:

defmodule MyApp.Blog do
  use Ash.Domain, extensions: [AshJsonApi.Domain]

  json_api do
    routes do
      base_route "/posts", MyApp.Blog.Post do
        get :read
        index :read
        post :create
        patch :update
        delete :destroy
      end
    end
  end

  resources do
    resource MyApp.Blog.Post
  end
end

Why Dual Version Support?

• Legacy Tooling - Some API gateways only support OpenAPI 3.0
• Modern Validation - OpenAPI 3.1 uses JSON Schema 2020-12
• Gradual Migration - Upgrade specs without breaking consumers

Development

mix test            # Run tests
mix check           # Run quality checks
mix docs            # Generate documentation
mix coveralls.html  # Check test coverage

References

• OpenAPI Specification
• Ash Framework
• AshJsonApi
• Oaskit
• JSON Schema

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT License. See LICENSE.md for details.