v0

[gorillamoe]

• "preserve comments" - see also: [Feature] Format support for multiline query parameters kulala-fmt#67
• Support global config (request-timeout, allow-insecure, ...)
• Respect headers (multiple headers with the same name, need to work too)
• feat/v0: Request handling: import and run #12
• feat/v0: Request handling: redirect response #10
• feat/v0: Request handling: auth #13
• feat/v0: Request handling: read body from file #11
• feat/v0: Request handling: operators #14
• Simple GET requests
• v0: Request handling: POST #4
• feat/v0: Request handling: GRAPHQL #7
• feat/v0: Request handling: WebSocket #8
• feat/v0: Request handling: GRPC #9
• v0: Request handling: variables #5
• feat/v0: refactor stdout/stderr response format #15

Features

• Supports kuba out of the box (kuba needs to be installed, in path and configured correctly).
• TS/JS Scripts without external nodejs requirement
  • Top-level async

Breaking Changes

Form-data

For multi-part form-data, we are going to have breaking-change for better UX:

### UPLOAD

POST https://example.com/upload HTTP/1.1
Content-Type: multipart/form-data

{
  "name": "John",
  "avatar": { "filePath": "./photo.jpg", "filename": "avatar.jpg" }
}

The shape of avatar is special (and "reserved"). It tells kulala-core to read the contents of filePath and send it as filename.

Payload

The general shape of the payload.

• action required: run|parse
• env optional: Default is default, any string - refers to the env in kuba and/or http-client.env.json
• filepath optional: string path to the .http file, relative to the cwd, or absolute (if the .http file contains external scripts, filepath is required for path resolving)
• content required string: because filepath is optional, the client needs to send the full content that should be processed (usually the file contents, or in Vim/Neovim the buffer contents)
• limit optional KulalaPayloadLimit: limit parse or run actions. If omitted, the whole content is parsed or run.

Payload: limit #

Payload: limit - cursorPosition #

{
  "action":"run",
  "env": "staging",
  "filepath": "test/simple.http",
  "content": "FILE_CONTENT_OF_HTTP_FILE_HERE",
  "limit": [
    {
      "filter": "cursorPosition",
      "line": 1,
      "column": 1
    }
  ]
}

Payload: limit - name #

for selecting a named request LOGIN_REQUEST:

### LOGIN_REQUEST

POST https://httpbin.org/post HTTP/1.1

{
  "username": "user123",
  "password": "pass123"
}

{
  "action":"run",
  "filepath": "test/simple.http",
  "content": "FILE_CONTENT_OF_HTTP_FILE_HERE",
  "limit": [
    {
      "filter": "name",
      "name": "LOGIN_REQUEST"
    }
  ]
}

Payload: limit - multiple #

For multiple limits (can also mix filters)

{
  "action":"run",
  "filepath": "test/simple.http",
  "content": "FILE_CONTENT_OF_HTTP_FILE_HERE",
  "limit": [
    {
      "filter": "name",
      "name": "LOGIN_REQUEST"
    },
    {
      "filter": "name",
      "name": "GRAPHQL_REQUEST"
    }
  ]
}