Explain technical work with code and field tables
Keep an endpoint’s explanation, request example and response beside the design discussion. API Documentation starts with editable text and native Code block objects for HTTP and JSON examples. Adapt the sample contract, add a field table when comparison helps and keep each snippet readable. The canvas becomes a technical reference the team can review visually and continue editing as the interface changes.
Canvas → Templates → API Documentation → Code block → Code languageWhat you’ll learn
- Edit native code blocks and choose their display language.
- Keep request, success and error examples consistent.
- Use an editable grid to compare field requirements.
Captured in Boilerrum with an illustrative project. The app interface is shown in English.
In this guide
01
Start from the endpoint reference
Open Templates, search for API Documentation and choose Use template. Inspect the Request, Response / 201 Created, Request fields and Error / 400 Bad Request sections. Replace the heading, endpoint and explanatory text with the contract you want to discuss. The supplied api.example.com address and task data are examples, so review them before treating the board as a reference.
02
Edit the request code
Select the request Code block and double-click its code preview to edit, or focus the selected block and press Enter or F2. Enter the request text in Code content. Use Code language in the header to choose HTTP, JSON or another appropriate language. Press Escape to return to preview and check that the content and language belong to this block.
03
Explain success and failure together
Edit the response and error blocks separately, keeping their Code language set appropriately for each example. Match field names, identifiers and status wording with the request explanation. Add a short sentence beside an error to explain what the caller should do next. These are documented examples for review; check their accuracy against the contract your team maintains.
04
Compare the field requirements
For a compact comparison, open Grid tools and select a four-row, four-column grid. Double-click cells to enter Field, Type, Required and Meaning in its header, then describe three request fields beneath it. Place the grid beside the code and compare the names with your snippets. Keep the template’s existing text rows only where they add useful explanation.
05
Check the reference and keep it usable
Leave code-editing mode and review the whole reference with Fit view. Inspect long lines, the smallest table text and whether the success and error examples still match the field descriptions. Save the canvas. For a review handout, add a frame and export it through Present → Frame options, then check the downloaded visual while retaining the editable blocks on the board.
Your canvas explains the endpoint through consistent request, response and error examples, with a readable field comparison. The team can review the contract visually and edit the original technical material in place.