API tools

The API category has three tools for reading API definitions and preparing requests. None of them sends a request.

OpenAPI and Swagger viewer

Path: /tools/api/swagger

An editor and documentation viewer for OpenAPI 3.x and Swagger 2.0 definitions, written in YAML or JSON.

• Open a file or edit the definition in the editor, with fold and unfold, find, a whitespace display and suggestions for keys and values.
• A Documentation pane with search across operations and an Expand all control.
• Generate samples fills each listed operation with a fresh sample.
• Convert the same document between YAML and JSON.
• Docs as Markdown turns the documentation into Markdown that you can copy, download or open in the Markdown editor.
• Layout options of editor and docs, or viewer only.
• The cURL line shown for an operation is a command for you to run yourself.

HTTP Headers

Path: /tools/api/http-headers

A reference and set of builders for HTTP headers, in two sections: All headers and Media types.

• Search headers by name, description or example, and filter by category and by direction (request headers, response headers, or both).
• A media types table searchable by type, extension or note, with a lookup by filename or extension.
• A Content-Type builder that handles the charset and a multipart boundary.
• An Accept header builder with q ranking.
• A Content-Encoding and Accept-Encoding explanation, and a list of what is not worth compressing.
• Cache-Control and Content-Disposition builders. The Content-Disposition builder handles non-ASCII file names with filename*=UTF-8'' plus an ASCII fallback.
• Each builder has a Copy button.

API Request Composer

Path: /tools/api/api-composer

Builds an HTTP request and generates a curl command. It does not send the request; the page states that you run the curl yourself.

• Set the method and URL, with {{variable}} placeholders, and fill in Params, Headers, Auth, Body, Options and Variables.
• See the generated curl command and copy it.
• Import a curl command and read it into the form.
• Save requests in a collection called My requests, rename the collection, and export it as a JSON file or open one.
• When requests are saved in this browser or exported, passwords, tokens, API keys and Authorization headers can be blanked or kept, whichever you choose.