Settings

The editor has no settings page. What it remembers is a convenience of the machine you use it on, kept by the host and never written to a spec, and what it reads about your project is in the files you commit.

In the editor

  • Theme. The toolbar’s theme button cycles through System, Light and Dark; its tooltip names the current one. In VS Code the editor takes the colours of VS Code’s theme, and the button is not shown.
  • Layout. The sizes of the panes, which parts of the window are hidden, and the severities hidden in the Problems tab are kept for the next visit. Enter on a focused splitter puts a pane back to its default size.
  • Try it out. The environment and the CORS proxy of Try-it settings are kept per spec folder.
  • Flow. Where you dragged the channels of the Flow diagram is kept per file; Reset layout forgets it.
  • What’s new. The dot on What’s new goes once you open the release notes of the version you run; the desktop app has the button since 0.13.0.

The web editor and the desktop app keep these in the page’s storage: in the browser, per site, and gone with the site’s data; in the desktop app, in the app’s own profile. My schemas of the Library are kept the same way (The Library).

On the desktop

  • Recent specs. File › Open Recent lists the last ten specs opened, newest first, and Clear Recent empties it. The app starts on the newest one that still exists, unless a spec is given on the command line: apigenie-editor <spec>.
  • The mock server. The app runs the apigenie-server that the APIGENIE_SERVER environment variable names, else one next to the app, else the first on the PATH; outside Windows it also looks in Homebrew’s folders.
  • Library folders are kept per spec folder; after a restart, Open on one asks for access again.

In VS Code

The extension’s settings, under API Genie in VS Code’s Settings:

Setting Default What it does
apigenie.editor.libraryFolders [] Library folders, by their path from the workspace folder, such as ../shared.
apigenie.serverPath "" The apigenie-server the mock server runs; empty takes the one on the PATH.
apigenie.tryIt.oauth2RedirectPort 33418 The port of the OAuth 2.0 redirect URL, http://127.0.0.1:<port>/oauth2-redirect.
apigenie.whatsNew.showAfterUpdate true A notice with What’s New after the extension is updated.

The editor opens with Open with API Genie Editor on a YAML or JSON file; VS Code’s own setting for the default editor of a file type makes it the default. The extension’s remaining settings, apigenie.tryIt.timeoutMs, apigenie.tryIt.maxResponseBytes and apigenie.tryIt.followRedirects among them, belong to its preview of OpenAPI documents, not to the editor.

In the project

  • apigenie.yaml configures the linter, in commands.lint and commands.lint.asyncapi, with the ruleset files its extends names (Fix problems).
  • http-client.env.json, http-client.private.env.json, .env and .env.<name> hold the environments of Try it out (Try it out).
  • apigenie-server.yaml, or the server’s section of the project’s configuration, receives the responses saved with Save as mock response.

Next

The three hosts compares the web editor, the desktop app and VS Code.

Last updated on View as Markdown
Was this helpful?