Skip to content

flik-lab/layang

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Layang logo

Layang

Website Version License: MIT

Layang is a workspace-based API workbench for testing, mocking, benchmarking, documenting, and automating APIs across gRPC, gRPC-Web, WebSocket, and REST.

Layang 1.0.1 is the first official stable release. It includes the full workspace workflow for REST, WebSocket, and gRPC APIs, with local mocks, scenario matching, response templates, request logs, generated docs, benchmarking, and CLI automation.

Layang workbench

Download

What Layang Does

  • Test gRPC, gRPC-Web, WebSocket, and REST APIs in one desktop workspace.
  • Save requests, examples, docs, environments, mocks, and history as readable files.
  • Run local mock servers for gRPC, WebSocket, and REST workflows.
  • Generate Markdown or HTML docs from proto files, saved examples, mocks, and responses.
  • Run CLI checks for CI/CD against the same workspace used in the desktop app.

Features

  • Import .proto files and browse services, methods, request types, and response types.
  • Run unary and server-streaming calls over gRPC-Web or native gRPC.
  • Save request tabs, metadata, environments, examples, tests, response history, and docs metadata in a workspace folder.
  • Edit per-method mock scenarios and run a local mock server from the desktop app.
  • Tune streaming mock interval, loop mode, max loops, and response sequences.
  • Run latency benchmarks and export benchmark JSON reports.
  • Generate Markdown or HTML API docs from proto files, saved examples, mocks, and latest responses.
  • Use the CLI in CI to validate workspaces, list saved requests, check mock scenarios, and run native gRPC requests.
  • Use the WebSocket workbench for live connections, message sending, local mock responses, benchmark exports, and generated docs.
  • Use the REST workbench for params, headers, auth, bodies, docs, examples, local mocks, scenario matching, and templates.

Release 1.0.0

The official 1.0.0 release brings REST, WebSocket, gRPC, and gRPC-Web into one stable workspace experience. REST support includes richer mock scenarios, query/header/body matching, response templates, request logs, and guide files for REST, gRPC, and WebSocket mocking.

Install

For most users, the simplest path is:

  1. Download the latest Windows installer from GitHub Releases.
  2. Run the installer.
  3. Open Layang from Start Menu or Desktop shortcut.
  4. On first launch, choose the workspace folder location you want to use.

Mocking And Streaming

Layang mock streaming

Mock scenarios live with the workspace and can be edited as JSON/YAML. Server-streaming methods can use repeated responses with interval and loop controls.

Documentation

Layang documentation

Generated docs can include proto metadata, saved examples, mock scenarios, and the latest saved responses. Export them as Markdown or HTML for static publishing.

CLI

pnpm run cli -- --help
pnpm run cli -- validate ./workspace --json
pnpm run cli -- list ./workspace
pnpm run cli -- run ./workspace --env dev --reporter junit --output reports/layang-junit.xml
pnpm run cli -- mock:check ./workspace

When the package is linked or installed, the command is exposed as layang.

Workspace

The desktop app can create or open a workspace folder. A workspace stores a snapshot plus Git-friendly files under folders such as protos/, requests/, examples/, docs/, environments/, history/, and mocks/.

The default desktop workspace is:

Documents/Layang/Workspace

You can also choose a custom workspace folder on first launch in the desktop app.

For Contributors

Development setup, local build commands, and packaging notes are in CONTRIBUTING.md.

License

MIT

Mock Guides

About

Layang is a gRPC-first, Layang is a workspace-based API workbench for testing, mocking, benchmarking, documenting, and automating APIs across gRPC, gRPC-Web, WebSocket, and REST.workflows.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors