Tính năng
- Gửi/Hủy/Chạy lại yêu cầu HTTP trong trình chỉnh sửa và xem phản hồi trong một khung riêng biệt với phần đánh dấu cú pháp
- Gửi truy vấn GraphQL và tác giả các biến GraphQL trong trình chỉnh sửa
- Gửi lệnh cURL trong trình chỉnh sửa và sao chép yêu cầu HTTP dưới dạng lệnh cURL
- Tự động lưu và xem/xóa lịch sử yêu cầu
- Soạn NHIỀU yêu cầu trong một tệp (được phân tách bằng dấu phân cách ###)
Vào extensions của VSCode instal Rest client => tạo file demo.http
Sử dụng
Tạo biến cho request có 2 cách
- Tạo biến trong file http: @host = https://demo.vn
- Tạo biến trong file settings.json của VSCode
- Nhấn nút settings ở góc trái bên dưới VSCode
- Trong ô tìm kiếm gõ: rest client => nhấn Edit in settings.json
- Trong file settings.json => tìm chữ rest-client.environmentVariables rồi khai báo biến trong $shared
123456<span class="token property">"rest-client.environmentVariables"</span><span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"$shared"</span><span class="token operator">:</span> <span class="token punctuation">{</span><span class="token property">"REACT_APP_API_URL"</span><span class="token operator">:</span> <span class="token string">"https://demo.vn"</span><span class="token punctuation">,</span><span class="token punctuation">}</span><span class="token punctuation">,</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
Tạo tên cho requests
- Request có tên là login => đặt dấu thăng ở đầu dòng => @name => tên request
1 2 3 4 | <span class="token comment"># @name login</span> POST <span class="token punctuation">{</span><span class="token punctuation">{</span>host<span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token operator">/</span>api<span class="token operator">/</span>users<span class="token operator">/</span>token<span class="token operator">/</span> content<span class="token operator">-</span><span class="token builtin">type</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token punctuation">{</span>contentType<span class="token punctuation">}</span><span class="token punctuation">}</span> |
Request url bao gồm
- Phương thức ( GET/POST/PATCH/DELETE)
- Url: như trong hình là {{host}}/api/users/token/ với host là biến khai báo ở trên
- Params:
1 2 | GET https<span class="token punctuation">:</span><span class="token operator">//</span>example<span class="token punctuation">.</span>com<span class="token operator">/</span>comments?page<span class="token operator">=</span><span class="token number">2</span><span class="token operator">&</span>pageSize<span class="token operator">=</span><span class="token number">10</span> |
- Body:
1 2 3 4 5 6 7 8 9 | <span class="token comment"># @name login</span> POST <span class="token punctuation">{</span><span class="token punctuation">{</span>host<span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token operator">/</span>api<span class="token operator">/</span>users<span class="token operator">/</span>token<span class="token operator">/</span> content<span class="token operator">-</span><span class="token builtin">type</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token punctuation">{</span>contentType<span class="token punctuation">}</span><span class="token punctuation">}</span> <span class="token punctuation">{</span> <span class="token string">"email"</span><span class="token punctuation">:</span> <span class="token string">"admin@demo.vn"</span><span class="token punctuation">,</span> <span class="token string">"password"</span><span class="token punctuation">:</span> <span class="token string">"demo"</span> <span class="token punctuation">}</span> |
Nhận giá trị từ response
Như dòng thứ 3 của hình trong phần tính năng ta gán access từ response của request có tên login cho biến token
Biến token này sẽ tự nhận giá trị khi request login được kích hoạt
1 2 | <span class="token decorator annotation punctuation">@token</span> <span class="token operator">=</span> <span class="token punctuation">{</span><span class="token punctuation">{</span>login<span class="token punctuation">.</span>response<span class="token punctuation">.</span>body<span class="token punctuation">.</span>access<span class="token punctuation">}</span><span class="token punctuation">}</span> |
Gán authorization token cho request
1 2 3 4 5 6 | <span class="token comment">### get profile</span> <span class="token comment"># @name me</span> GET <span class="token punctuation">{</span><span class="token punctuation">{</span>host<span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token operator">/</span>api<span class="token operator">/</span>users<span class="token operator">/</span>me<span class="token operator">/</span> content<span class="token operator">-</span><span class="token builtin">type</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token punctuation">{</span>contentType<span class="token punctuation">}</span><span class="token punctuation">}</span> Authorization<span class="token punctuation">:</span> Bearer <span class="token punctuation">{</span><span class="token punctuation">{</span>token<span class="token punctuation">}</span><span class="token punctuation">}</span> |
Với ### nằm giữa các request giúp các request tách biệt với nhau