Http Files

.http files are a simple way to quickly invoke your API endpoints because you don't have to leave your IDE to use a separate tool. I use it regularly when I'm building a new feature.

You can commit this file to your repository so that your teammates can also make use of it!

HTTP files are supported by most IDEs (for Visual Studio Code, you'll have to install the REST Client extensions), the only caveat is that the variables syntax is (currently) different between Visual Studio products and JetBrains products.

Here's an example of a .http file for a Todo API:

 todoitems.http content_paste
@base=https://localhost:5167
 
### Create a new item
 
POST {{base}}/todoitems
Content-Type: application/json
 
{
  "id": "{{$guid}}",
  "name":"walk dog",
  "isComplete":false
}
 
### Get All items
 
GET {{base}}/todoitems
 
### Update item
 
PUT {{base}}/todoitems/1
Content-Type: application/json
 
{
  "id": 1,
  "name":"walk dog",
  "isComplete": true
}
 
### Delete item
 
DELETE {{base}}/todoitems/1

For more information, check out the documentation for the various IDEs:

• Visual Studio
• Visual Studio Code (HTTP extension)
• JetBrains Rider
• JetBrains WebStorm

Support me

I appreciate it if you would support me if have you enjoyed this post and found it useful, thank you in advance.

Share this bit on

Twitter LinkedIn