Funciones de la API de Mascotas

Con estas funciones de la API, puedes gestionar las mascotas en la base de datos de tu tienda.

Añadir una nueva mascota

Añade una nueva mascota a la base de datos de la tienda.

Punto final: https://petstore3.swagger.io/api/v3/pet

Operación: POST

Ejemplos

Clave API
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <TU_CLAVE_API>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

Respuestas

Código	Descripción
200	Operación exitosa
400	Entrada inválida
404	Mascota no encontrada
422	Excepción de validación
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parámetros

Cuerpo de la solicitud

Nombre	Tipo	Descripción
body	Objeto mascota	(Obligatorio) El objeto `Pet` para agregar a la tienda.

Actualizar una mascota existente

Actualiza una mascota existente por su ID.

Punto final: https://petstore3.swagger.io/api/v3/pet

Operación: PUT

Ejemplos

Clave API
OAuth 2.0

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <TU_CLAVE_API>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

Respuestas

Código	Descripción
200	Operación exitosa
400	Entrada inválida
404	Mascota no encontrada
422	Excepción de validación
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parámetros

Cuerpo de la solicitud

Nombre	Tipo	Descripción
body	Objeto mascota	(Obligatorio) Objeto mascota para actualizar.

Encontrar una mascota por estado

Encuentra mascotas por su estado.

Punto final: https://petstore3.swagger.io/api/v3/pet/findByStatus

Operación: GET

Ejemplos

Clave API
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	Operación exitosa
400	Entrada inválida
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

Parámetros

Parámetros de consulta

Nombre	Tipo	Descripción
status	string	Estado de la mascota a buscar. Por defecto: `available`. Valores permitidos: `available`, `pending`, `sold`.

Encontrar mascotas por etiquetas

Encuentra mascotas por sus etiquetas.

Punto final: https://petstore3.swagger.io/api/v3/pet/findByTags

Operación: GET

Ejemplos

Clave API
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	Operación exitosa
400	Entrada inválida
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

Parámetros

Parámetros de consulta

Nombre	Tipo	Descripción
tags	array	Etiquetas para filtrar. Por defecto: `[]`. Valores permitidos: Cualquier nombre de etiqueta válido.

Encontrar una mascota por Id

Encuentra una mascota por su ID único.

Punto final: https://petstore3.swagger.io/api/v3/pet/{petId}

Operación: GET

Ejemplos

Clave API
OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	Operación exitosa
400	ID inválido suministrado
404	Mascota no encontrada
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
petId	integer	ID de la mascota a devolver

Actualizar una mascota con datos de formulario

Actualiza una mascota en la tienda con datos de formulario.

Punto final: https://petstore3.swagger.io/api/v3/pet/{petId}

Operación: POST

Ejemplos

Clave API
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <TU_CLAVE_API>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

Respuestas

Código	Descripción
200	Operación exitosa
405	Entrada inválida
default	Error inesperado

Ejemplo de respuesta

200: Operación exitosa

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
petId	integer	ID de la mascota a actualizar

Parámetros de consulta

Nombre	Tipo	Descripción
name	string	Nombre de la mascota a actualizar
status	string	Estado de la mascota a actualizar

Eliminar una mascota

Elimina una mascota de la base de datos.

Punto final: https://petstore3.swagger.io/api/v3/pet/{petId}

Operación: DELETE

Ejemplos

Clave API
OAuth 2.0

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <TU_CLAVE_API>"

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	Mascota eliminada
400	ID inválido suministrado
404	Mascota no encontrada

(Una eliminación exitosa devuelve un código 200 sin cuerpo de respuesta.)

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
petId	integer	ID de la mascota a eliminar

Subir una imagen

Sube una imagen para una mascota.

Punto final: https://petstore3.swagger.io/api/v3/pet/{petId}/uploadImage

Operación: POST

Ejemplos

Clave API
OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "api_key: <TU_CLAVE_API>" \
--form "file=@/path/to/your/file"

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
--form "file=@/path/to/your/file"

Respuestas

Código	Descripción
200	Operación exitosa
default	Error inesperado

Ejemplos de respuesta

200: Operación exitosa

{
  "code": 200,
  "type": "unknown",
  "message": "datos adicionales"
}

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
petId	integer	ID de la mascota a actualizar

Parámetros de datos del formulario

Nombre	Tipo	Descripción
additionalMetadata	string	Datos extra para pasar al servidor.
file	file	Archivo a subir.

Añadir una nueva mascota​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Cuerpo de la solicitud​

Actualizar una mascota existente​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Cuerpo de la solicitud​

Encontrar una mascota por estado​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Parámetros de consulta​

Encontrar mascotas por etiquetas​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Parámetros de consulta​

Encontrar una mascota por Id​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Parámetros de ruta​

Actualizar una mascota con datos de formulario​

Ejemplos​

Respuestas​

Ejemplo de respuesta​

Parámetros​

Parámetros de ruta​

Parámetros de consulta​

Eliminar una mascota​

Ejemplos​

Respuestas​

Parámetros​

Parámetros de ruta​

Subir una imagen​

Ejemplos​

Respuestas​

Ejemplos de respuesta​

Parámetros​

Parámetros de ruta​

Parámetros de datos del formulario​

Añadir una nueva mascota

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Cuerpo de la solicitud

Actualizar una mascota existente

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Cuerpo de la solicitud

Encontrar una mascota por estado

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Parámetros de consulta

Encontrar mascotas por etiquetas

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Parámetros de consulta

Encontrar una mascota por Id

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Parámetros de ruta

Actualizar una mascota con datos de formulario

Ejemplos

Respuestas

Ejemplo de respuesta

Parámetros

Parámetros de ruta

Parámetros de consulta

Eliminar una mascota

Ejemplos

Respuestas

Parámetros

Parámetros de ruta

Subir una imagen

Ejemplos

Respuestas

Ejemplos de respuesta

Parámetros

Parámetros de ruta

Parámetros de datos del formulario