openapi-demo/empleados.yaml

78 lines
2.0 KiB
YAML
Raw Normal View History

2024-05-22 11:36:08 +00:00
openapi: 3.0.0
info:
title: API de Ejemplo de Usuarios
description: API para administrar usuarios
version: 1.0.0
servers:
- url: https://miapp.midominio.com/tienda/
paths:
/usuarios:
post:
summary: Agregar un nuevo usuario
description: Crea un nuevo usuario en la aplicación.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nombre:
type: string
edad:
type: integer
responses:
'201':
description: Usuario creado con éxito
'400':
description: Error en la solicitud
/usuarios/{id}:
delete:
summary: Borrar un usuario existente
description: Elimina un usuario de la aplicación por su ID.
parameters:
- in: path
name: id
required: true
description: ID del usuario a borrar
schema:
type: integer
format: int64
responses:
'204':
description: Usuario eliminado con éxito
'404':
description: Usuario no encontrado
put:
summary: Actualizar un usuario existente
description: Actualiza la información de un usuario existente en la aplicación por su ID.
parameters:
- in: path
name: id
required: true
description: ID del usuario a actualizar
schema:
type: integer
format: int64
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nombre:
type: string
edad:
type: integer
responses:
'200':
description: Usuario actualizado con éxito
'400':
description: Error en la solicitud
'404':
description: Usuario no encontrado