Edit request: the offline request builder

Fill in parameters, the request body, the server and credentials, and every code sample and Copy for AI follow. Apifolio never sends the request: an alternative to Try it out that runs on Atlassian.

Every endpoint has an Edit request button under the language tabs of its code samples. It opens a form built from the spec, and what you type goes straight into the code samples, in every language, and into the endpoint's Copy for AI. Apifolio builds the request; you run it from your terminal or API client.

What you can fill in

  • Server: pick one of the spec's servers and fill in its variables: a dropdown for listed values, a text field otherwise (free text is URL-encoded in the samples).
  • Credentials for the selected security scheme: a token, an API key, or a user name and password. For mutual TLS, set up the client certificate in your HTTP client.
  • Path, query, header and cookie parameters: listed values and booleans become dropdowns, lists take comma-separated values, and object parameters take JSON. Fields start with the spec's examples and defaults, and required fields are marked. An optional parameter is included once you fill it in or tick it.
  • Body: an editable JSON body that starts from the selected example (or the oneOf variant you picked in the schema). Form bodies are edited as a JSON object and encoded by the samples. For file uploads, the samples use a placeholder file name to replace with your file.

Values are checked against the spec: type, listed values, minimum and maximum, length, format and pattern. An invalid JSON body shows the line and column of the error, and the samples keep the last valid body.

Parameter examples named in the spec appear as chips under each parameter: with the editor open, a click fills the value in; with the editor closed, a click copies it.

Reset starts again from the spec's values (the credentials you typed stay). Close editor drops every value.

What happens to your values

  • Nothing is sent. Apifolio makes no request to your API, and no network call at all for the editor.
  • Nothing is saved. Values live in the memory of the browser tab only, never in browser storage or in the Confluence page, and are gone when you close the editor or the page.
  • Credentials stay masked. The credential fields hide what you type, and the code on screen shows •••••••• in their place. The copy button of a code sample copies the real request, credentials included. The endpoint's Copy for AI never includes them.

Put secrets only in the credential fields: they are the fields that stay masked and out of Copy for AI.

Why there is no "Try it out" button

A live request from Confluence would send your data, and often your credentials, from your Confluence site to a server outside Atlassian, and the API would have to allow cross-origin calls from Confluence (CORS). Apifolio is built to never send data outside Atlassian, so it gives you the same filled-in request, ready to run, instead. See What Apifolio does not do, and why.

View as Markdown