Neovim HttpYac

A very simple plugin which integrates HttpYac in Neovim.

I currently use it to to run REST requests, I don't need much, but I'll add functionalities once I need them.

It basically runs httpyac cli against the current file, executing all request or the one under the cursor, so you can use vars, envs, etc... It provides syntax highlighting for the responses.

Important

You need to have HttpYac installed and in path! i.e. npm install -g httpyac

Installation

With LazyVim:

return {
  "abidibo/nvim-httpyac",
  config = function ()
    require('nvim-httpyac').setup({
      output_view = "vertical" -- "vertical" | "horizontal"
    })
    -- if you want to set up the keymaps
    vim.keymap.set('n', '<Leader>rr', '<cmd>:NvimHttpYac<CR>', { desc='Run request'})
    vim.keymap.set('n', '<Leader>ra', '<cmd>:NvimHttpYacAll<CR>', { desc='Run all requests'})
    vim.keymap.set('n', '<Leader>rp', '<cmd>:NvimHttpYacPicker<CR>', { desc='Run named request'})
    vim.keymap.set('n', '<Leader>re', '<cmd>:NvimHttpYacEnv<CR>', { desc='Select environment'})
    vim.keymap.set('n', '<Leader>rc', '<cmd>:NvimHttpYacEnvClear<CR>', { desc='Clear environment'})
  end
}

Configuration

You can configure the plugin by passing a table to the setup function.

• output_view: Defines how the output window is opened. Can be "vertical" (default) or "horizontal".

Commands

Tip

It's not mandatory to save the file before running the requests,the current buffer content will be used

• NvimHttpYac: executes the request under the cursor
• NvimHttpYacAll: executes all the requests
• NvimHttpYacPicker: shows a picker with all the named requests
• NvimHttpYacEnv: shows a picker to select the active environment (sticky across requests)
• NvimHttpYacEnvClear: clears the active environment

The first three commands take optional parameters that are passed to httpyac. E.g. to use a specific dev environment call :NvimHttpYac --env dev

Environment selector

The :NvimHttpYacEnv command discovers environments automatically by scanning for:

• http-client.env.json / http-client.private.env.json (IntelliJ format — top-level keys are environment names)
• .env.{name} and {name}.env dotenv files

Files are searched in the current file's directory, the project root, and the env/ subfolder.

Once selected, the environment is sticky — it is automatically appended to all subsequent requests until cleared with :NvimHttpYacEnvClear or a new environment is selected. If you pass --env explicitly to a command, the sticky environment is ignored for that execution.

Credits

This plugin was inspired by the following projects:

• HttpYac: for the great cli tool
• rest.nvim: for the syntax highlighting
• vimyac: for the idea