Skip to content

flik-lab/layang

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Layang logo

Layang

Website Version License: MIT

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

Layang 1.0.4 focuses on day-to-day desktop reliability: manual mock scenario refresh from workspace files, multiple imported HTTPS certificates, certificate-list management without a PEM editor, app zoom shortcuts, and a simpler workspace logo menu.

Layang workbench

Download

What Layang Does

  • Test REST, WebSocket, gRPC, and gRPC-Web 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.
  • Reload mock scenario files manually when they are edited outside Layang.
  • Trust internal HTTPS/APISIX certificates through imported .pem, .crt, or .cer files.
  • 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.
  • Use Update from file to pull external edits from mocks/mock-server.json and mocks/scenarios/** into the editor and running mock server.
  • Tune streaming mock interval, loop mode, max loops, and response sequences.
  • Import multiple trusted HTTPS certificates and review them by file name, source path, and SHA-256 fingerprint.
  • Use Ctrl++, Ctrl+-, and Ctrl+0 to resize the desktop UI.
  • 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.4

The 1.0.4 release keeps the existing workspace model and improves the desktop workflow around mocks, certificates, and accessibility.

Highlights:

  • Manual Update from file for mock scenarios, so external file edits are pulled only when the user asks for them.
  • Multiple certificate import for .pem, .crt, and .cer files.
  • Certificate settings now show an imported certificate list instead of a PEM editor.
  • Duplicate certificates are deduplicated by fingerprint.
  • Certificate settings stay local to the desktop user profile, not the workspace.
  • App zoom shortcuts are persisted locally.
  • The Layang logo menu is limited to workspace actions and certificate settings.

Install

For most users, the simplest path is:

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

Windows packaging and auto-update details are documented in WINDOWS_SETUP.md.

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. When a scenario file is edited in another editor, click Update from file in Layang to refresh the UI and running mock server.

Certificate Settings

Certificate settings are available from the Layang logo menu. Import one or more .pem, .crt, or .cer files to trust internal HTTPS, APISIX, gRPC-Web, or native gRPC lab targets. Layang shows the imported certificate list and SHA-256 fingerprints; the raw PEM editor is intentionally not shown in the UI.

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/.

Machine-local settings such as imported certificates, TLS bypass, logger settings, and zoom level are stored under Electron userData, not inside the workspace.

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.

Mock Guides

License

MIT

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

11 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors