Quick Start

Create a new project

npm create shiftapi@latest

This scaffolds a full-stack Go + TypeScript app with end-to-end types.

Or add to an existing Go project

Install the Go package

ShiftAPI requires Go 1.27 or later. Route registration uses generic methods, which landed in that release.

go get github.com/fcjr/shiftapi

Define your API

package main

import (
    "log"
    "net/http"

    "github.com/fcjr/shiftapi"
)

type HelloRequest struct {
    Name string `json:"name" validate:"required"`
}

type HelloResponse struct {
    Message string `json:"message"`
}

func main() {
    api := shiftapi.New(shiftapi.WithInfo(shiftapi.Info{
        Title:   "My API",
        Version: "1.0.0",
    }))

    api.Handle("POST /hello", func(r *http.Request, in HelloRequest) (*HelloResponse, error) {
        return &HelloResponse{Message: "Hello, " + in.Name + "!"}, nil
    })

    log.Fatal(shiftapi.ListenAndServe(":8080", api))
}

Add the frontend plugin

Vite

npm install shiftapi @shiftapi/vite-plugin

vite.config.ts

import { defineConfig } from "vite";
import { shiftapi } from "@shiftapi/vite-plugin";

export default defineConfig({
  plugins: [shiftapi()],
});

Next.js

npm install shiftapi @shiftapi/next

next.config.ts

import { withShiftAPI } from "@shiftapi/next";

export default withShiftAPI({});

Use the typed client

import { client } from "@shiftapi/client";

const { data } = await client.POST("/hello", {
    body: { name: "World" },
});

console.log(data.message);
//               ^? (property) message: string