Laboratorio de serialización de parámetros de OpenAPI

Obtenga una vista previa de cómo los parámetros de ruta, consulta, encabezado y cookie de OpenAPI se serializan según el estilo y la configuración de explosión, localmente.

Pegue o elija un documento OpenAPI 3.0, 3.1 o 3.2, inspecciónelo, seleccione una operación de ruta y ajuste el valor de cada parámetro JSON. Obtenga una vista previa de la ruta, la cadena de consulta, los encabezados y las cookies, luego copie las partes que necesita.

Cargue un documento OpenAPI, elija una operación y luego obtenga una vista previa de cómo sus parámetros se convierten en un destino de solicitud, encabezados y cookies. No se envía ninguna solicitud.

Pegue JSON o YAML a continuación, o elija un archivo.

Hasta 2 MB y 300 operaciones de ruta. Soporta OpenAPI 3.0, 3.1 y 3.2. Las referencias externas no se recuperan.

Cómo utilizar

Compruebe cómo aparece un parámetro API en el cable

Obtenga una vista previa de cómo los parámetros de ruta, consulta, encabezado y cookie de OpenAPI se serializan según el estilo y la configuración de explosión, localmente.

Paso a paso

  1. Introduce la fuente mediante: Especificación de OpenAPI.
  2. Ejecuta: Inspeccionar especificación. Revisa el resultado antes de copiarlo, descargarlo o usarlo en otro lugar.
  3. Configura: Operación de ruta. Consulta la referencia para elegir lo que corresponda a tu tarea.
  4. Ejecuta: Vista previa de serialización. Revisa el resultado antes de copiarlo, descargarlo o usarlo en otro lugar.
  5. Pegue o elija un documento OpenAPI 3.0, 3.1 o 3.2, inspecciónelo, seleccione una operación de ruta y ajuste el valor de cada parámetro JSON. Obtenga una vista previa de la ruta, la cadena de consulta, los encabezados y las cookies, luego copie las partes que necesita.

Cómo elegir los ajustes

OpciónQué cambia
Operación de rutaAplica el estilo OpenAPI y la configuración de explosión a los parámetros de ruta, consulta, encabezado y cookie. Los estilos comunes admitidos incluyen simple, etiqueta, matriz, formulario, espacio delimitado, tubería delimitada y deepObject.
Vista previa de serializaciónLos parámetros basados ​​en contenido, matrices u objetos anidados, combinaciones de estilos no definidos y referencias externas no se adivinan. Los valores del encabezado se muestran sin codificación URI porque las reglas de citación del encabezado dependen del encabezado. El esquema no está validado.

Ejemplo y resultado esperado

Para GET /users/{id}, una matriz de consulta `tag: [api, local]` con `style: form` y `explode: true` se convierte en `tag=api&tag=local`. Un valor de ruta escalar se codifica antes de insertarlo en la ruta. La herramienta no valida el esquema ni envía una solicitud; Las codificaciones de contenido no compatibles, los valores anidados y las referencias externas se dejan para revisión manual.

Si no funciona

  • Los parámetros basados ​​en contenido, matrices u objetos anidados, combinaciones de estilos no definidos y referencias externas no se adivinan. Los valores del encabezado se muestran sin codificación URI porque las reglas de citación del encabezado dependen del encabezado. El esquema no está validado.
  • No. La herramienta solo crea una vista previa local para la operación seleccionada. No resuelve servidores, no agrega autenticación ni envía solicitudes de red.
  • Si falla el análisis, revisa la sintaxis JSON o YAML antes de los hallazgos de la API. Incluye las referencias locales necesarias en el mismo documento. Las referencias externas sin resolver y los esquemas no admitidos requieren revisión manual; no se descargan ni se prueba el servidor.

¿Qué serializa esta herramienta?

Aplica el estilo OpenAPI y la configuración de explosión a los parámetros de ruta, consulta, encabezado y cookie. Los estilos comunes admitidos incluyen simple, etiqueta, matriz, formulario, espacio delimitado, tubería delimitada y deepObject.

¿Qué necesita revisión manual?

Los parámetros basados ​​en contenido, matrices u objetos anidados, combinaciones de estilos no definidos y referencias externas no se adivinan. Los valores del encabezado se muestran sin codificación URI porque las reglas de citación del encabezado dependen del encabezado. El esquema no está validado.

¿Llama a la API?

No. La herramienta solo crea una vista previa local para la operación seleccionada. No resuelve servidores, no agrega autenticación ni envía solicitudes de red.