> For the complete documentation index, see [llms.txt](https://gigi206.gitbook.io/vscode-anywhere/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gigi206.gitbook.io/vscode-anywhere/modules/list/rest.md).

# Rest

![](https://humao.gallerycdn.vsassets.io/extensions/humao/rest-client/0.24.1/1592028624802/Microsoft.VisualStudio.Services.Icons.Default)

## About

REST, or REpresentational State Transfer, is an architectural style for providing standards between computer systems on the web, making it easier for systems to communicate with each other. REST-compliant systems, often called RESTful systems, are characterized by how they are stateless and separate the concerns of client and server. We will go into what these terms mean and why they are beneficial characteristics for services on the Web.

Source: <https://www.codecademy.com/articles/what-is-rest>

## Installation

Change `enable` from `False` to `True` in the `rest` section (cf [module installation](/vscode-anywhere/modules/install.md)).

```yaml
vscode-anywhere:
    rest:
        enabled: True
```

{% hint style="info" %}
You can also take a look at the [VSCode-Anywhere rest module configuration](https://github.com/gigi206/VSCode-Anywhere/blob/V2/salt/modules/rest/defaults.yaml).
{% endhint %}

## Requirements

No requirements.

## VSCode

### VSCode extensions

#### platformio.platformio-ide

[This extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) is a REST Client allows you to send HTTP request and view the response in Visual Studio Code directly.

![](https://raw.githubusercontent.com/Huachao/vscode-restclient/master/images/usage.gif)

### VSCode settings

No [settings](https://code.visualstudio.com/docs/getstarted/settings).

### VSCode keybindings

No [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings).

## Software

No software.

## Documentation

No documentation.

## VSCode-Anywhere

### Environment

No environment.

### Specific settings

No specific settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gigi206.gitbook.io/vscode-anywhere/modules/list/rest.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
