🎉 HTTL 0.1.7 is released, now we have CLI. Read more →
Skip to Content
Language GuideOpenAPI

OpenAPI

Yes, yes and yes, HTTL supports the OpenAPI specification.

Note

HTTL supports Swagger 2.x and OpenAPI 3.x specifications.

To integrate an OpenAPI specification file, simply add the @spec directive with the URL pointing to your OpenAPI specification.

Syntax

@spec: <url>

Example

@spec: https://httl.dev/api/spec.json
 
get <type '/' or press Ctrl+Space | Option+Esc to see the list of available paths>

IntelliSense

HTTL can autocomplete the paths and methods from the OpenAPI specification file.


OpenAPI Autocomplete

HTTL can automatically generate the request body based on the OpenAPI specification.

To utilize this feature:

  • Press the spacebar after the URL.
  • HTTL will generate the request body.
  • Accept the generated body by pressing the Tab key.

OpenAPI Autocomplete

You can also use Ctrl+Space | Option+Esc to see the list of available body schema.

đź’ˇ
Tip

This feature is particularly useful when the IDE’s IntelliSense conflicts with other plugins, especially Copilot’s autogeneration.


OpenAPI Autocomplete
Note

There is no IntelliSense for the body shema yet but it’s coming soon.

Last updated on
DirectivesVariables