Features •Install •Usage •Contribute

Important

If you are facing issues, pleasereport them so we can work in a fix together :)

Features

Install

Note

Checkthis troubleshooting guide if you have any issues whileinstalling this plugin.

Dependencies

rocks.nvim (recommended)

:Rocks install rest.nvim

lazy.nvim

{"rest-nvim/rest.nvim",dependencies= {"nvim-treesitter/nvim-treesitter",opts=function (_,opts)opts.ensure_installed=opts.ensure_installedor {}table.insert(opts.ensure_installed,"http")end,  }}

Important

You need lazy.nvim higher than v11 to install rockspec dependencies

Setup

---@typerest.Optsvim.g.rest_nvim= {-- ...}

Note

You can also check out:h rest-nvim.config for documentation.

Default configuration

---rest.nvim default configuration---@classrest.Configlocaldefault_config= {---@typetable<string,fun():string> Table of custom dynamic variablescustom_dynamic_variables= {},---@classrest.Config.Requestrequest= {---@typeboolean Skip SSL verification,useful for unknown certificatesskip_ssl_verification=false,---Default request hooks---@classrest.Config.Request.Hookshooks= {---@typeboolean Encode URL before making requestencode_url=true,---@typestring Set`User-Agent`header when it is emptyuser_agent="rest.nvim v"..require("rest-nvim.api").VERSION,---@typeboolean Set`Content-Type`header when it is empty and body is providedset_content_type=true,        },    },---@classrest.Config.Responseresponse= {---Default response hooks---@classrest.Config.Response.Hookshooks= {---@typeboolean Decode the request URL segments on response UI to improve readabilitydecode_url=true,---@typeboolean Format the response body using`gq`commandformat=true,        },    },---@classrest.Config.Clientsclients= {---@classrest.Config.Clients.Curlcurl= {---Statistics to be shown, takes cURL's `--write-out` flag variables---See `man curl` for `--write-out` flag---@typeRestStatisticsStyle[]statistics= {                {id="time_total",winbar="take",title="Time taken"},                {id="size_download",winbar="size",title="Download size"},            },---Curl-secific request/response hooks---@classrest.Config.Clients.Curl.Optsopts= {---@typeboolean Add`--compressed`argument when`Accept-Encoding`header includes---`gzip`set_compressed=false,---@typetable<string,Certificate> Table containing certificates for each domainscertificates= {},            },        },    },---@classrest.Config.Cookiescookies= {---@typeboolean Whether enable cookies support or notenable=true,---@typestring Cookies file pathpath=vim.fs.joinpath(vim.fn.stdpath("data")--[[@as string]],"rest-nvim.cookies"),    },---@classrest.Config.Envenv= {---@typebooleanenable=true,---@typestringpattern=".*%.env.*",---@typefun():string[]find=function()localconfig=require("rest-nvim.config")returnvim.fs.find(function(name,_)returnname:match(config.env.pattern)end, {path=vim.fn.getcwd(),type="file",limit=math.huge,            })end,    },---@classrest.Config.UIui= {---@typeboolean Whether to set winbar to result paneswinbar=true,---@classrest.Config.UI.Keybindskeybinds= {---@typestring Mapping for cycle to previous result paneprev="H",---@typestring Mapping for cycle to next result panenext="L",        },    },---@classrest.Config.Highlighthighlight= {---@typeboolean Whether current request highlighting is enabled or notenable=true,---@typenumber Duration time of the request highlighting in millisecondstimeout=750,    },---@seevim.log.levels---@typeinteger log level_log_level=vim.log.levels.WARN,}

Usage

HTTP file syntax

Method Request-URI HTTP-VersionHeader-field: Header-valueRequest-Body

Note

rest.nvim followsintellij's http client specfor.http file syntax. You can find examples of use in thespec/examplesdirectory.

Keybindings

Commands

Lua scripting

http://localhost:8000# @lang=lua> {%local json = vim.json.decode(response.body)json.data = "overwritten"response.body = vim.json.encode(json)%}

Extensions

Telescope Extension

-- first load extensionrequire("telescope").load_extension("rest")-- then use it, you can also use the `:Telescope rest select_env` commandrequire("telescope").extensions.rest.select_env()

Mappings

Config

Lualine Component

-- Just add a component in your lualine config{sections= {lualine_x= {"rest"    }  }}-- To use a custom icon and color{sections= {lualine_x= {      {"rest",icon="",fg="#428890"      }    }  }}

Contribute

Important

rest.nvim usessemantic commits that adhere tosemantic versioning and these help with automatic releases, please use this type of conventionwhen submitting changes to the project.

Related software

License