Explica el trabajo técnico con código y tablas de campos
Mantén la explicación de un endpoint, su petición de ejemplo y su respuesta junto al debate de diseño. API Documentation incluye texto editable y objetos nativos Code block para ejemplos HTTP y JSON. Adapta el contrato de muestra, añade una tabla de campos si facilita la comparación y conserva fragmentos legibles. El canvas se convierte en una referencia técnica visual que puede evolucionar con la interfaz.
Canvas → Templates → API Documentation → Code block → Code languageQué aprenderás
- Editar bloques nativos y elegir su lenguaje de visualización.
- Mantener coherentes los ejemplos de petición, éxito y error.
- Comparar requisitos de campos en una cuadrícula editable.
Capturado en Boilerrum con un proyecto de ejemplo. La interfaz se muestra en inglés.
En esta guía
01
Empezar con la referencia del endpoint
Busca API Documentation en Templates y elige Use template. Revisa Request, Response / 201 Created, Request fields y Error / 400 Bad Request. Cambia el título, el endpoint y las explicaciones por el contrato que quieras debatir. La dirección api.example.com y los datos de tareas son ejemplos; revísalos antes de usar el tablero como referencia.
02
Editar el código de la petición
Selecciona el Code block de la petición y haz doble clic en la vista previa, o enfoca el bloque seleccionado y pulsa Intro o F2. Edita la petición en Code content. Usa Code language en el encabezado para elegir HTTP, JSON u otro lenguaje adecuado. Pulsa Escape para volver a la vista previa y comprueba el contenido y el lenguaje del bloque.
03
Explicar juntos el éxito y los errores
Edita por separado los bloques de respuesta y error y elige el Code language adecuado para cada ejemplo. Haz coincidir campos, identificadores y estados con la explicación de la petición. Añade junto a un error una frase sobre lo que debe hacer quien llama. Son ejemplos documentados para revisar; contrástalos con el contrato que mantiene el equipo.
04
Comparar los requisitos de campos
Para una comparación compacta, abre Grid tools y elige cuatro filas y cuatro columnas. Haz doble clic en las celdas para escribir Field, Type, Required y Meaning en la cabecera y describe tres campos debajo. Coloca la cuadrícula junto al código y compara los nombres con los fragmentos. Conserva las filas de texto originales solo si añaden una explicación útil.
05
Revisar la referencia y mantener su utilidad
Sal de la edición de código y revisa toda la referencia con Fit view. Comprueba las líneas largas, el texto pequeño de la tabla y la coherencia de los ejemplos con las descripciones de campos. Guarda el canvas. Para una revisión, añade un marco y expórtalo mediante Present → Frame options; comprueba el archivo descargado y conserva los bloques editables en el tablero.
El canvas explica el endpoint con ejemplos coherentes de petición, respuesta y error y una comparación clara de campos. El equipo puede revisar el contrato visualmente y editar el material técnico original en su sitio.