fiberplaneHonoOpenApiStarter

Example Hono-Zod-OpenAPI app with a Fiberplane API explorer.

For an example with regular-old Hono, see: https://www.val.town/v/fiberplane/fiberplaneHonoStarter

1. Import @fiberplane/hono

Create val
import { createFiberplane } from "https://esm.sh/@fiberplane/hono@0.4.3-valtown.1";

2. Expose your OpenAPI spec

Create val
app.doc("/doc", {
  openapi: "3.0.0",
  info: {
    title: "User Management API",
    version: "v1.0.0",
  },
});

3. Mount the api explorer

Create val
import { createFiberplane } from "https://esm.sh/@fiberplane/hono@0.4.3-valtown.1";
import { OpenAPIHono } from "https://esm.sh/@hono/zod-openapi@0.18.4";

const app = new OpenAPIHono();

// ... Define your api routes here!

app.use(
  "/*",
  createFiberplane({
    openapi: { url: "/doc" },
  }),
);

export default app.fetch;

4. Visit your Val's root route to play with the API explorer!

createFiberplane mounts a UI at the root route (/), which can be used to explore the api's routes and make requests. Think of it like an embedded, lightweight postman.