Skip to content
| Marketplace
Sign in
Visual Studio Code>Visualization>ApiaristNew to Visual Studio Code? Get it now.
Apiarist

Apiarist

LeoSchmit

|
111 installs
| (1) | Free
Found a bug in Apiarist? Please let us know via github issues.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Make Legacy Code Readable Without Touching The Code, Just Using .yaml

Getting started

Install

Open this extension in the Visual Studio Marketplace

Samples

After installation you will see this:

Click "Create with Samples". The "apiarist" directory will be created and the content will be displayed as follows:

In the "apiarist" directory, you can find a file called "routes.yaml":

  • apiarist_version: 1 - this will help to render content correctly in the future when we have versions 2, 3, etc
  • title: Selector - you can write any title here
  • routes - here you can add your routes
    • name - any name
    • id - specify the path to the .yaml file here. For example example/create_message_as_seller
    • children - here you can add child elements

Next open example/create_message_as_seller.yaml

  • apiarist_version: 1 - the same as in the previous file
  • viewer - List of elements to render
    • call - ClassName.functionName which you want to display. If you don't have a class, just the name of the function. For different languages, the call may be different. E.g. for java it's ClassName.functionName(Type). You can figure this out in the 'Outline' tab of the vscode explorer:

      In case of js the call should be Buyer.example1
    • regexp - instead of call you can specify a regexp. This can be useful for legacy code where you have very long functions with a lot of logic inside
      • pattern - E.g. (else if[^]*?})
      • flags - You can read about flags here
    • name - any name. In case of absence, the call will be used
    • icon - icon name from the icons.yaml file
    • path - path to a file where call can be found
    • status - you can specify collapsed here if you want to collapse child elements

apiarist/icons.yaml:

  • apiarist_version: 1 - the same as in the previous file
  • icons - List of icons
    • name - any name
    • icon - the name of the VSCode icon. A complete list of icons can be found here
    • iconFile - you can put your icons in the "icons" directory and use them
      • light - icon path for VSCode Light Theme
      • dark - icon path for VSCode Dark Theme

Apiarist on VSCode Web

You can install and try Apiarist on https://vscode.dev/

Any questions? Ask in chat!

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft