x-codeSamples u obtenlos de Speakeasy.
Configura api.examples.languages en tu docs.json para elegir qué lenguajes aparecen en los ejemplos generados. Los lenguajes se muestran en el orden en que los enumeras.
docs.json
defaults como required para omitir los parámetros opcionales de los ejemplos generados. El valor predeterminado, all, los incluye.
Todos los lenguajes compatibles
Todos los lenguajes compatibles
api.examples.autogenerate como false. Las páginas de endpoint mostrarán entonces solo los x-codeSamples de tu especificación, o los componentes <RequestExample> en las páginas MDX.
Agrega la propiedad x-codeSamples a cualquier operación. Tiene el siguiente esquema.
La etiqueta del ejemplo. Es útil cuando se proporcionan varios ejemplos para un mismo endpoint.
1
Obtén la URL de la especificación combinada desde el registro
Ve a tu Panel de Speakeasy y abre la pestaña API Registry. Abre la entrada 
Desde la página de la entrada del registro, copia la URL pública proporcionada.
*-with-code-samples de tu API.
Si la entrada no está etiquetada como Combined Spec, asegúrate de que tu API tenga configurada una URL de ejemplos de código automáticos.
2
Agrega la URL de la especificación combinada a tu archivo docs.json
Agrega la URL de la especificación combinada a un anchor o a una pestaña en el objeto
navigation de tu archivo docs.json.3
Verifica la integración
Después de volver a desplegar tu documentación, abre cualquier endpoint en tu referencia de API y confirma que los fragmentos de lenguaje aparecen en el área de pruebas. El conjunto de lenguajes disponibles coincide con los targets de SDK configurados en tu proyecto de Speakeasy.Si los fragmentos no aparecen, comprueba que:
- La URL
openapiendocs.jsonapunte a la entrada de la especificación combinada*-with-code-samples, no al archivo OpenAPI de origen. - La URL de la especificación combinada sea accesible públicamente desde el navegador.
- Tu proyecto de Speakeasy tenga configurada una URL de ejemplos de código automatizados y al menos un target de SDK habilitado.