basic-gateway

// Minimal gateway example — the simplest possible Stoma configuration.
// Creates a gateway that proxies requests to an upstream API with
// request logging and CORS enabled globally.
// Demo API: https://stoma.opensource.homegrower.club/demo-api

import { createGateway, cors, requestLog } from "@homegrower-club/stoma";

const gateway = createGateway({
  // Friendly identifier shown in logs, admin UI, and metrics
  name: "my-gateway",

  // Prefix added to all route paths — requests to /api/users/*
  // will match route path /users/*
  basePath: "/api",

  // Global policies run on every request before route-specific policies
  policies: [requestLog(), cors()],

  routes: [
    {
      // URL pattern with wildcard support
      // * matches one segment: /users/123 but not /users/123/posts
      path: "/users/*",

      pipeline: {
        // Route-specific policies (in addition to global)
        policies: [],

        // Upstream: where to send the request after policies pass
        upstream: {
          type: "url",
          target: "https://stoma.opensource.homegrower.club/demo-api",
          rewritePath: (path) => path.replace("/api", ""),
        },
      },
    },
  ],
});

export default gateway;

Open in Editor

Key Concepts

Property	Purpose	Example Value
name	Identifier for logs/admin	"my-gateway"
basePath	Prefix for all routes	"/api"
routes[].path	URL pattern to match	"/users/*"
pipeline.policies	Middleware for this route	[jwtAuth(), rateLimit()]
upstream.target	Destination URL	"https://api.example.com"
upstream.rewritePath	Path transformation	(path) => path.replace("/api", "")

Next Steps

• Add authentication: See JWT Auth or API Key Auth
• Add rate limiting: See Rate Limit
• Add caching: See Cache
• See a full example: Real World Example