Contract

# List all available methods
mizu contract ls

# Show details about a specific method
mizu contract show todo.Create

# Call a method with JSON data
mizu contract call todo.Create '{"title":"Buy milk"}'

# Export the OpenAPI specification
mizu contract spec > openapi.json

# Pass as argument
mizu contract ls http://api.example.com

# Use the --url flag
mizu contract ls --url http://api.example.com

# Use environment variable
export MIZU_URL=http://api.example.com
mizu contract ls

mizu contract ls [url] [flags]

mizu contract ls

todo
  todo.Create               POST   /api/todo            Create a new todo item
  todo.List                 GET    /api/todo            List all todo items
  todo.Get                  GET    /api/todo/{id}       Get a todo by ID
  todo.Update               PUT    /api/todo/{id}       Update a todo item
  todo.Delete               DELETE /api/todo/{id}       Delete a todo item

mizu contract ls --json

{
  "services": [{
    "name": "todo",
    "methods": [{
      "name": "Create",
      "fullName": "todo.Create",
      "httpMethod": "POST",
      "httpPath": "/api/todo",
      "input": {"id": "CreateTodoInput", "name": "CreateTodoInput"},
      "output": {"id": "Todo", "name": "Todo"}
    }]
  }],
  "types": [...]
}

mizu contract show <method> [url] [flags]

mizu contract show todo.Create

todo.Create
  POST /api/todo

  Create a new todo item

Input (CreateTodoInput):
  title           string   required  The title of the todo item
  description     string             Optional description
  priority        integer            Priority level (1-5)

Output (Todo):
  id              string   required  Unique identifier
  title           string   required  Todo title
  description     string             Description
  completed       boolean  required  Completion status
  createdAt       string   required  Creation timestamp

mizu contract show todo.Create --schema

mizu contract call <method> [input] [url] [flags]

mizu contract call todo.Create '{"title":"Buy milk","priority":1}'

{
  "id": "abc123",
  "title": "Buy milk",
  "priority": 1,
  "completed": false,
  "createdAt": "2024-01-15T10:30:00Z"
}

# Create input file
echo '{"title":"Buy groceries"}' > input.json

# Call with file
mizu contract call todo.Create @input.json

echo '{"title":"Buy groceries"}' | mizu contract call todo.Create -

mizu contract call todo.Get --id abc123

mizu contract call todo.Create '{"title":"Secret todo"}' \
  -H "Authorization: Bearer mytoken"

error: rpc error -32602: title is required

mizu contract spec [url] [flags]

mizu contract spec > openapi.json

mizu contract spec --pretty > openapi.json

mizu contract spec -o openapi.json

Wrote openapi.json

mizu contract spec --format openrpc > openrpc.json

mizu contract types [type] [url] [flags]

mizu contract types

CreateTodoInput           object     3 fields
Todo                      object     5 fields
UpdateTodoInput           object     4 fields
Priority                  enum       5 values

mizu contract types Todo

Todo (object)
  id              string   required
  title           string   required
  description     string
  completed       boolean  required
  createdAt       string   required

mizu contract types Todo --schema

{
  "type": "object",
  "required": ["id", "title", "completed", "createdAt"],
  "properties": {
    "id": {"type": "string", "description": "Unique identifier"},
    "title": {"type": "string", "description": "Todo title"},
    "description": {"type": "string"},
    "completed": {"type": "boolean"},
    "createdAt": {"type": "string", "format": "date-time"}
  }
}

# Start by listing what's available
mizu contract ls

# Pick a method and see its details
mizu contract show users.Create

# Try calling it
mizu contract call users.Create '{"name":"Alice","email":"[email protected]"}'

# Export the spec
mizu contract spec --pretty -o api.json

# Use tools like Swagger UI or Redoc to visualize
npx @redocly/cli preview-docs api.json

# In terminal 1: Run your server
mizu dev

# In terminal 2: Test your methods
mizu contract call todo.Create '{"title":"Test item"}'
mizu contract call todo.List

#!/bin/bash
# Verify API is working

# Wait for server to start
sleep 5

# Check discovery works
if ! mizu contract ls --json > /dev/null; then
  echo "API discovery failed"
  exit 1
fi

# Check a specific method
RESULT=$(mizu contract call health.Check)
if [ $? -ne 0 ]; then
  echo "Health check failed"
  exit 1
fi

echo "API is healthy"

error: cannot discover contract at http://localhost:8080

error: method not found: todo.Unknown

did you mean?
  todo.Create
  todo.Update

error: missing required input
  the todo.Create method requires input

hint: mizu contract call todo.Create '{...}'
      mizu contract show todo.Create  # see input schema