Taller DevOps
Planificar una API
1
Se necesita definir un servicio Web que al consultar el método “/persona” retorne
la información personal (Ocupará el JSON definido en el ejercicio anterior).
Ingresar al siguiente enlace.
https://studio.apicur.io/dashboard
Pedirá autenticación y se debe asociar con la cuenta de GOOGLE.
Se muestra la siguiente pantalla.
Los pasos para definir una nueva API son los siguientes:
- Seleccionar la opción Crear nueva API
Ingrese los datos que se presentan a continuación:
• Nombre: datum-devops
• Descripción: Definición de una API
• Template: Blank
2
Presione el botón Edit API
Se nos muestra la siguiente pantalla donde se planifica las características que
se deben tomar en cuenta en la API por ejemplo:
• Información de contacto
• TAGS para definir características de la API
• Servidores donde se realizaría el despliegue
• Esquemas de seguridad (HTTP, API Key, OAuth2, OpenID connect)
3
Para nuestro ejemplo no se completara esta información sino que solo se
construirá el detalle del endpoint (Dirección URL) que se solicita.
Iniciaremos creando los Data Types:
Ingrese la siguiente información:
4
• Nombre: Persona
• Descripción: Datos de la persona
• JSON de ejemplo: Ingrese el JSON creado en el ejercicio anterior
• Finalmente presione el botón salvar
La información debe registrarse como en las siguientes capturas
5
Se observa que el Data Type se debe haber creado como en la siguiente
captura.
6
Procedemos con la creación del path dando un clic en el enlace “Add a path” y
colocamos el path “/persona”
7
Procedemos a realizar la definición del EndPoint.
Ingresamos la siguiente información
• Sumary: Recuperar persona
• Description: API para recuperar los datos de la persona
• Server: http://emp.datumredsoft.com/api/persona
8
Procedemos a agregar los métodos de la API (Es posible definir mas
características pero esta fuera del alcance de la práctica).
Presionamos el botón “Add Operation” y vemos que se resalta el método Get.
Procedemos a agregar la respuesta (Es posible definir muchas mas
características de los métodos del endpoint pero estan fuera del alcance de la
práctica).
Presionamos el enlace “Add a response”.
9
Seleccionamos el código de la respuesta que para nuestro caso es 200, algunos
de los códigos mas utilizados son:
• 200 Todo esta OK
• 401: Error en la autenticación
• 409: Error en la solicitud
• 500: Error interno del servidor
Presionamos el enlace “Add a media type”
10
Seleccionamos de los datos que se muestran el tipo Persona.
Procedemos a agregar un ejemplo y nos aparece el siguiente cuadro de dialogo
donde ingresamos el nombre, presionamos el botón generar y finalmente el
botón Add.
11
Finalmente para revisar todos los detalles del API que se debe construir
presionamos el botón de la esquina superior derecha “Live Documentation” y se
nos presenta la información que debe ser entregada a los equipos de desarrollo.
12
13
14
