Preguntas frecuentes

¿Por qué el cuerpo de la solicitud/respuesta está vacío aunque haya un objeto de esquema?

Comprueba que tu objeto de esquema defina un tipo. Si no lo hace, mostraremos el texto <type> en la tabla. properties por sí solo no basta para indicar que el esquema es un objeto.

Por ejemplo:

content:
application/json:
schema:
properties:
id:
type: number
name:
type: string
content:
application/json:
schema:
type: object <-- added
properties:
id:
type: number
name:
type: string

¿Cómo reordeno las operaciones?

Las operaciones (por ejemplo, GET /version , POST /reference) se ordenan según el orden que tienen en la propia definición de OpenAPI. Usamos tags para agrupar las operaciones, pero no modificamos el orden. Por ejemplo:

# If the operations and tags are specified as such in the API definition:

paths:
'/cat':
post:
tags:
- Cats
...
get:
tags:
- Cats
...
'/dog':
get:
tags:
- Dogs
...
post:
tags:
- Dogs
...
tags:
- name: 'Dogs'
- name: 'Cats'
# The operations and tags would be ordered as such in the API reference:

# Dogs
# GET /dog
# POST /dog
# Cats
# POST /cat
# GET /cat

Puedes reordenar libremente las operaciones en tu definición de OpenAPI según necesites para crear el recorrido adecuado para tus lectores.

Para reordenar, abre la referencia en nuestro API Editor y edita el orden de las rutas, operaciones o etiquetas directamente en la vista Source; la referencia se vuelve a renderizar en ese orden al guardar.

  Última actualización