A fast Neovim http client written in Lua.
rest.nvim
makes use of a curl wrapper made in pure Lua by tami5 and implemented
in plenary.nvim
so, in other words, rest.nvim
is a curl wrapper so you don't
have to leave Neovim!
IMPORTANT: If you are facing issues, please report them
- 2021-11-04: HTTP Tree-Sitter parser now depends on JSON parser for the JSON bodies detection, please install it too.
- 2021-08-26: We have deleted the syntax file for HTTP files to start using the tree-sitter parser instead, please see Tree-Sitter parser section for more information.
- 2021-07-01: Now for getting syntax highlighting in http files you should
add a
require('rest-nvim').setup()
to yourrest.nvim
setup, refer to packer.nvim. This breaking change should allow lazy-loading ofrest.nvim
.
- Easy to use
- Fast execution time
- Run request under cursor
- Syntax highlight for http files and output
- Possibility of using environment variables in http files
WARNING: rest.nvim requires Neovim >= 0.5 to work.
- System-wide
- curl
- Optional [can be changed, see config bellow]
- jq (to format JSON output)
- tidy (to format HTML output)
- Other plugins
use {
"rest-nvim/rest.nvim",
requires = { "nvim-lua/plenary.nvim" },
config = function()
require("rest-nvim").setup({
-- Open request results in a horizontal split
result_split_horizontal = false,
-- Keep the http file buffer above|left when split horizontal|vertical
result_split_in_place = false,
-- Skip SSL verification, useful for unknown certificates
skip_ssl_verification = false,
-- Encode URL before making request
encode_url = true,
-- Highlight request on run
highlight = {
enabled = true,
timeout = 150,
},
result = {
-- toggle showing URL, HTTP info, headers at top the of result window
show_url = true,
show_http_info = true,
show_headers = true,
-- executables or functions for formatting response body [optional]
-- set them to nil if you want to disable them
formatters = {
json = "jq",
html = function(body)
return vim.fn.system({"tidy", "-i", "-q", "-"}, body)
end
},
},
-- Jump to request line on run
jump_to_request = false,
env_file = '.env',
custom_dynamic_variables = {},
yank_dry_run = true,
})
end
}
We are using a Tree-Sitter parser for our HTTP files, in order to get the correct syntax highlighting
for HTTP files (including JSON bodies) you should add the following into your ensure_installed
table
in your tree-sitter setup.
ensure_installed = { "http", "json" }
Or manually run :TSInstall http json
.
By default rest.nvim
does not have any key mappings so you will not have
conflicts with any of your existing ones.
To run rest.nvim
you should map the following commands:
<Plug>RestNvim
, run the request under the cursor<Plug>RestNvimPreview
, preview the request cURL command<Plug>RestNvimLast
, re-run the last request
result_split_horizontal
opens result on a horizontal split (default opens on vertical)result_split_in_place
opens result below|right on horizontal|vertical split (default opens top|left on horizontal|vertical split)skip_ssl_verification
passes the-k
flag to cURL in order to skip SSL verification, useful when using unknown certificatesencode_url
flag to encode the URL before making requesthighlight
allows to enable and configure the highlighting of the selected request when send,jump_to_request
moves the cursor to the selected request line when send,env_file
specifies file name that consist environment variables (default: .env)custom_dynamic_variables
allows to extend or overwrite built-in dynamic variable functions (default: {})
Create a new http file or open an existing one and place the cursor over the
request method (e.g. GET
) and run rest.nvim
.
NOTES:
rest.nvim
follows the RFC 2616 request format so any other http file should work without problems.You can find examples of use in tests
- Fork it (https://github.com/rest-nvim/rest.nvim/fork)
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
rest.nvim is MIT Licensed.