specter

specter

English

specter は軽量なモック API サーバーです。エンドポイントを YAML で定義して、すぐに起動できます。

• Hot reload: config.yml を編集すると変更がすぐ反映されます
• Response templates、faker、stateful mocking、rate limiting に対応
• 単一バイナリで動作し、追加のランタイム依存はありません

インストール

Docker

docker run -v $(pwd)/config.yml:/config.yml ghcr.io/saku0512/specter -c /config.yml

Homebrew (macOS / Linux)

brew tap Saku0512/specter https://github.com/Saku0512/specter
brew install specter

curl (macOS / Linux)

curl -fsSL https://raw.githubusercontent.com/Saku0512/specter/main/install.sh | bash

PowerShell (Windows)

irm https://raw.githubusercontent.com/Saku0512/specter/main/install.ps1 | iex

Quick start

specter init          # config.yml を生成
specter init --template crud  # CRUD スターターを生成
specter examples      # サンプル設定を一覧表示
specter doctor -c config.yml  # 設定・参照ファイル・ポートを診断
specter -c config.yml # サーバーを起動

routes:
  - path: /users
    method: GET
    response:
      - id: 1
        name: Alice

この設定で GET /users にアクセスすると、YAML に書いたレスポンスが返ります。

ドキュメント

• Config reference — routes、matching、templates、faker、state、rate limiting など
• Examples gallery — auth、CRUD、pagination、GraphQL、webhook、SSE、OpenAPI など
• Comparison guide — json-server、Prism、WireMock との違い
• JSON Schema — エディタ補完・validation 用 schema
• VS Code Extension — Specter config の補完と inline validation
• CLI reference — flags、env vars、init / examples / gen / validate / doctor / record
• Introspection API — /__specter/requests、/__specter/state

動作する設定例は config.example.yml を見てください。

ライセンス

MIT