https://github.com/heilgar/nvim-http-client
Easy to use HTTP client plugin for neovim. Same syntax as IntelliJ HTTP client
https://github.com/heilgar/nvim-http-client
http-client lua neovim neovim-plugin nvim-lua nvim-plugin vim vim-plugin
Last synced: 11 days ago
JSON representation
Easy to use HTTP client plugin for neovim. Same syntax as IntelliJ HTTP client
- Host: GitHub
- URL: https://github.com/heilgar/nvim-http-client
- Owner: heilgar
- License: mit
- Created: 2024-09-09T03:13:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-06T02:57:49.000Z (about 1 month ago)
- Last Synced: 2025-10-06T04:34:56.511Z (about 1 month ago)
- Topics: http-client, lua, neovim, neovim-plugin, nvim-lua, nvim-plugin, vim, vim-plugin
- Language: Lua
- Homepage:
- Size: 478 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - heilgar/nvim-http-client - Easy to use HTTP client with IntelliJ (JetBrains) HTTP client syntax compatibility. (Programming Languages Support / Web Development)
- trackawesomelist - heilgar/nvim-http-client (⭐11) - Easy to use HTTP client with IntelliJ (JetBrains) HTTP client syntax compatibility. (Recently Updated / [Apr 09, 2025](/content/2025/04/09/README.md))
- awesome-neovim-sorted - heilgar/nvim-http-client
- awesome-neovim-sorted - heilgar/nvim-http-client
README
# Neovim HTTP Request Plugin
A Neovim plugin for running HTTP requests directly from .http files, with support for environment variables. Inspired by the IntelliJ HTTP Client, this plugin brings similar functionality to Neovim in an easy-to-install and easy-to-use package.
The core goal is to ensure compatibility with .http files from IntelliJ or VSCode, allowing them to run smoothly in Neovim and vice-versa.
**Development is ongoing, with new features added as needed or when time permits.**
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Keybindings](#keybindings)
- [Features](#features)
- [Feature Comparison](#feature-comparison)
- [Documentation](#documentation)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
## Installation
This plugin is designed to be installed with [Lazy.nvim](https://github.com/folke/lazy.nvim).
### Quick Start (Copy & Paste)
Copy this complete configuration into your Lazy.nvim setup:
```lua
{
"heilgar/nvim-http-client",
dependencies = {
"nvim-lua/plenary.nvim",
"hrsh7th/nvim-cmp", -- Optional but recommended for enhanced autocompletion
"nvim-telescope/telescope.nvim", -- Optional for better environment selection
},
event = "VeryLazy",
ft = { "http", "rest" },
config = function()
require("http_client").setup({
-- Default configuration (works out of the box)
default_env_file = '.env.json',
request_timeout = 30000,
split_direction = "right",
create_keybindings = true,
user_agent = "heilgar/nvim-http-client", -- Custom User-Agent header
-- Profiling (timing metrics for requests)
profiling = {
enabled = true,
show_in_response = true,
detailed_metrics = true,
},
-- Default keybindings (can be customized)
keybindings = {
select_env_file = "hf",
set_env = "he",
run_request = "hr",
stop_request = "hx",
toggle_verbose = "hv",
toggle_profiling = "hp",
dry_run = "hd",
copy_curl = "hc",
save_response = "hs",
set_project_root = "hg",
get_project_root = "hgg",
},
})
-- Set up Telescope integration if available
if pcall(require, "telescope") then
require("telescope").load_extension("http_client")
end
end
}
```
> **Note about Autocompletion**: If you have nvim-cmp installed, HTTP-specific autocompletion sources are automatically registered and configured for `.http` and `.rest` files. You don't need any additional configuration! The plugin provides completion for HTTP methods, headers, environment variables, and content types out of the box.
For full configuration options, see [Configuration Documentation](doc/configuration.md).
## Usage
1. Create a `.http` file with your HTTP requests.
2. Create a `.env.json` file with your environments.
3. Use the provided commands to select an environment and run requests.
### Commands
- `:HttpEnvFile`: Select an environment file (.env.json) to use
- `:HttpEnv`: Select an environment from the current environment file
- `:HttpRun`: Run the HTTP request under the cursor
- `:HttpRunAll`: Run all HTTP requests in the current file
- `:HttpStop`: Stop the currently running HTTP request
- `:HttpVerbose`: Toggle verbose mode for debugging
- `:HttpProfiling`: Toggle request profiling
- `:HttpDryRun`: Perform a dry run of the request under the cursor
- `:HttpCopyCurl`: Copy the curl command for the HTTP request under the cursor
- `:HttpSaveResponse`: Save the response body to a file
- `:HttpSetProjectRoot [path]`: Set the project root for file searching operations (use without arguments to be prompted for the path)
- `:HttpGetProjectRoot`: Display the current project root for file searching operations
### Keybindings
The plugin comes with the following default keybindings (if `create_keybindings` is set to `true`):
- `hf`: Select environment file
- `he`: Set current environment
- `hr`: Run HTTP request under cursor
- `hx`: Stop running HTTP request
- `hv`: Toggle verbose mode
- `hp`: Toggle request profiling
- `hd`: Perform dry run
- `hc`: Copy curl command
- `hs`: Save response to file
- `hg`: Set project root for file searching
- `hpg`: Get current project root
## Features
- Run HTTP requests from .http files
- Support for environment variables
- Easy switching between different environments
- Non-blocking requests
- Pretty-printed response display in a separate buffer
- Automatic formatting for JSON and XML responses
- Syntax highlighting for .http files and response buffers
- Verbose mode for debugging
- Dry run capability for request inspection
- Request profiling with detailed timing metrics
- Telescope integration for environment selection
- Autocompletion for HTTP methods, headers and environment variables
- Custom User-Agent header (`heilgar/nvim-http-client` by default)
- Compatible with [JetBrains HTTP Client](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html) and [VSCode Restclient](https://github.com/Huachao/vscode-restclient)
### Feature Comparison
Below is a comparison between this plugin and JetBrains HTTP Client, showing what's already implemented and what's planned for future releases:
| Feature | Status | Notes |
|---------|--------|-------|
| Basic HTTP requests | ✅ | All HTTP methods, headers, body |
| Environment variables | ✅ | Including private env files |
| Response formatting | ✅ | JSON, XML with syntax highlighting |
| Post-request scripts | ✅ | Response handlers with `> {% ... %}` syntax |
| Variable autocompletion | ✅ | Environment variables, headers, methods |
| Request profiling | ✅ | Detailed timing metrics |
| Response history | ✅ | Last 10 responses preserved |
| Dry run & curl export | ✅ | Preview requests before sending |
| Custom SSL certificate handling | ✅ | Self-signed certificate support |
| Request chaining | ⚠️ | Basic support via global variables |
| Authentication helpers | ⚠️ | Basic support through headers |
| Response headers folding | ⚠️ | Basic support via Neovim folds |
| Cookie management | ❌ | Planned |
| Pre-request scripts | ❌ | High priority - planned |
| File upload handling | ❌ | High priority - planned |
| GraphQL support | ❌ | Planned |
| Redirects configuration | ❌ | Planned |
| WebSocket/gRPC support | ❌ | Planned |
| Response schema validation | ❌ | Planned |
| Response diff comparison | ❌ | Planned |
| Request collections | ❌ | Planned |
| Generated client code | ❌ | Planned |
| Response testing/assertions | ❌ | Planned |
| Proxy configuration | ❌ | Planned |
| Request rate limiting | ❌ | Planned |
| Batch request processing | ❌ | Planned |
| Request signing (AWS, etc.) | ❌ | Planned |
| OpenAPI/Swagger integration | ❌ | Multiple features planned: |
| - Direct execution from Swagger files | ❌ | **High priority** - Run requests directly from .yaml/.json OpenAPI files |
| - Import from OpenAPI specs | ❌ | Generate .http files from spec definitions |
| - Generate OpenAPI specs | ❌ | Create specs from existing requests |
| - API documentation viewer | ❌ | Visualize API documentation within Neovim |
| Postman compatibility | ❌ | Multiple features planned: |
| - Direct execution from Postman files | ❌ | Run requests directly from Postman collection files |
| - Import Postman collections | ❌ | Convert Postman requests to .http format |
| - Import Postman environments | ❌ | Convert to .env.json format |
| - Export to Postman format | ❌ | For sharing with Postman users |
**Legend**:
- ✅ = Fully implemented
- ⚠️ = Partially implemented
- ❌ = Not yet implemented
## Documentation
For detailed documentation on specific features, see:
- [Configuration Guide](doc/configuration.md) - Complete configuration options
- [Environment Files and Variables](doc/environments.md) - Working with environments
- [Response Handling](doc/response-handling.md) - Response viewing and handling
- [Request Profiling](doc/profiling.md) - Performance profiling features
- [Telescope Integration](doc/telescope-integration.md) - Using with Telescope
- [Autocompletion](doc/autocompletion.md) - Autocompletion features
You can also access the plugin's help documentation by running `:h http_client` in Neovim.
## Screenshots
### Dry Run
This screenshot shows the dry run feature, which allows you to preview the HTTP request before sending it.
### Environment Selection
This image demonstrates the environment selection within a chosen .env.json file, allowing you to switch between different configurations.
### HTTP Response
This screenshot displays how HTTP responses are presented after executing a request.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Read our [Contributing Guidelines](.github/CONTRIBUTING.md).
2. Ensure you've updated the `CHANGELOG.md` file with your changes.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.