seampact

v1.0

Install

The command line and the generators come from your ecosystem’s registry, at the same version.

npm

npm install --save-dev @seampact/cli @seampact/codegen-ts

Gradle

build.gradle.kts

plugins {
    id("io.github.jubasse.seampact") version "1.0.0"
}

Maven

pom.xml

<plugin>
  <groupId>io.github.jubasse</groupId>
  <artifactId>seampact-maven-plugin</artifactId>
  <version>1.0.0</version>
</plugin>

Composer

composer require seampact/laravel seampact/hooks
# Symfony: composer require seampact/symfony

pip

pip install "seampact-fastapi[generate]"
# Django REST Framework: seampact-drf, Django Ninja: seampact-ninja

Each ecosystem has its own steps: Install in other ecosystems.

Types and validation

What each stack generates from your schemas, and what happens when a request breaks a check. Start with the overview.

TypeScript typesOne type per schema, request, reply and error.

zod and yupValidators for the Node servers.

class-validatorDecorated DTO classes for NestJS.

Java recordsRecords and a generated validator on Spring Boot.

Laravel and SymfonyForm rules and constraints.

Pydantic and DRFModels and serializers for Python.

Server guides

Eleven servers, one contract. Pick yours.

Node.js

NestJSDecorators and a module.

ExpressExpress 4 and 5.

FastifyFastify 5 with route hooks.

AdonisJSAdonisJS 7 and 6.

HonoHono 4 on any Web-standard runtime.

Java

Spring BootThe Gradle or Maven plugin, controllers and hooks.

PHP

LaravelComposer, controllers, hooks and Laravel's own auth.

SymfonyThe bundle, controllers, hooks and SecurityBundle.

Python

FastAPIThe wheels, bind functions, handlers and hooks.

Django REST FrameworkSettings, URLconf, handlers and hooks.

Django NinjaHandlers, hooks and Ninja's own auth.

Client guides

The client reads the contract only, so any server can sit behind it.

TypeScript

Fetch clientThe typed fetch client every other client builds on.

ReactTanStack Query, SWR or RTK Query hooks.

VueTanStack Query, Pinia Colada or plain fetch composables.

AngularAn HttpClient service with signals.

MSW mocksTyped mock handlers to test with no backend.

Expo and React NativeThe client and the React hooks on a phone.

Point the client at your backendThe backend URL per environment.

Start here

Your first APIA notes API on the server of your choice, step by step.

GlossaryThe words these docs use, one meaning each.

All the documentationThe full index, page by page.