API PROYECTO.
Aprendiz:
Glorimar Alexandra Prieto Dos Ramos
Instructor:
Alex Eduardo Zambrano
1
Página
Tabla de contenido
INTRODUCCION ............................................................................................................................................ 3
OBJETIVOS .................................................................................................................................................... 4
API................................................................................................................................................................. 5
PASO A PASO................................................................................................................................................. 5
Pruebas en Postman ..................................................................................................................................... 8
Repositorio en GitHub ................................................................................................................................ 11
Video Narrado del Testing con Postman..................................................................................................... 11
ENDPOINT ................................................................................................................................................... 12
ENDPOINTS DE NUESTRA API .......................................................................................................... 13
URL .............................................................................................................................................................. 14
Diferencias entre URN, URL y URI ............................................................................................................... 15
CONCLUSIONES........................................................................................................................................... 16
REFERENCIAS .............................................................................................................................................. 17
2
Página
INTRODUCCION
Veremos los conceptos y pasos para el desarrollo de una API REST, utilizando las tecnologías
del Backend como Python y el sistema de bases de datos no relacional como lo es MySQL. De
esta forma se inicia con la puesta a punto del entorno de desarrollo con Visual Studio Code, el
cual será el espacio de trabajo donde se construirá la API. Adicionalmente, se comprenderá la
importancia del uso de los comandos (en la terminal) para la instalación y configuración de
paquetes necesarios para el correcto funcionamiento del proyecto, de igual manera, se ilustra
algunas buenas prácticas de desarrollo y herramientas que harán más prolijo el código.
Una vez construida la API se inicia con un testing a través de la herramienta Postman, que es
muy utilizada para este tipo de desarrollos. Así, se corrobora las respuestas y solicitudes de
un tipo de proyectos de esta naturaleza.
3
Página
OBJETIVOS
✓ Crear un servicio para ser utilizado en un Registro.
✓ Hacer un servicio para ser utilizado en un Inicio de Sesión.
✓ Realizar validaciones de verificación correctamente.
✓ Utilizar Herramientas de Versionamiento.
✓ Instalar Postman.
✓ Testing de la API construida usando la herramienta Postman.
✓ Grabar un video para mostrar el testing con Postman.
✓ Entregar ENDPPOINT de la API.
✓ Realizar los servicios necesarios para cumplir las características del software.
✓ Crear documentación de cada uno de los servicios.
4
Página
API.
PASO A PASO:
Activación de entorno virtual
5
Página
Código Python
6
Página
Página
7
Pruebas en Postman:
Registro y acceso.
8
Página
Si el usuario no está registrado.
Nuevo registro.
9
Página
Visualización en la base de datos.
10
Página
Repositorio en GitHub:
[Link]
Video Narrado del Testing con Postman:
Video adjunto en Territorium con la evidencia, pero fuera de este documento.
11
Página
ENDPOINT.
Un ENDPOINT es una pasarela que conecta los procesos del servidor de la aplicación
con una interfaz externa, es decir, es la dirección a la que se envían las peticiones.
Es importante mencionar como funciona la API para entender que son los ENDPOINT.
API es la abreviatura de una Interfaz de Programación de Aplicaciones. Las aplicaciones
utilizan las APIs para interactuar con servicios de terceros y sus usuarios.
Para conectarse a la API, es necesario enviar una solicitud. Para el correcto
procesamiento de la solicitud, el cliente debe proporcionar un puntero universal de
recursos (URL), un método HTTP y, dependiendo del método, añadir cabeceras,
cuerpo y parámetros de solicitud.
12
Las cabeceras proporcionan metadatos sobre la solicitud, mientras que el cuerpo contiene
Página
datos, como los campos de las nuevas filas de la base de datos.
La API procesara la solicitud y enviara la respuesta recibida al servidor.
La respuesta contendrá un código de estado, que es una parte del mensaje de respuesta
HTTP que informa al cliente del resultado de la solicitud. Por ejemplo, el código 200 se utiliza si
la operación se ha completado con éxito, el código 500 si se ha producido un error del
servidor.
Los ENDPOINTS funcionan junto con los métodos de la API. Son URLs específicas que la
aplicación utiliza para comunicarse con servicios de terceros y con sus usuarios.
Ilustración 1 Ejemplos de ENDPOINTS dentro de una estructura de URL
ENDPOINTS DE NUESTRA API
• Para registrar un usuario: [Link]
13
• Para iniciar sesión: [Link]
Página
URL:
Una URL es la ruta que puede manejar diferentes métodos de solicitud. Cada tipo de
petición es un ENDPOINT diferente. Existen 5 tipos principales de ellos:
• GET - Obtiene información del servidor; no requiere un cuerpo de petición;
• POST - Crea un nuevo objeto en la base de datos, requiere un cuerpo de petición con
los campos de este objeto;
• PUT - Restablece completamente un objeto específico en la base de datos;
• PATCH - Similar a PUT, restablece un objeto específico en la base de datos, pero sólo
actualizará los campos que se mencionan en el cuerpo de la petición;
• DELETE - Elimina el objeto de la base de datos.
Cuando se crea una petición especifica, se le pueden añadir varios parámetros. La
combinación de estos parámetros y la URL- Uniform Resource Locator (esta secuencia de
caracteres sirve, por ejemplo, para dirigir a páginas web u otros medios alojados en servidores
informáticos, por lo que es gracias a ella que navegamos por Internet), representan un URI-
Uniform Resource Identifier (Identificador de Recursos Uniforme), es el que indica donde y
como encontrar el recurso.
URN- Unifor Resource Name: Es un formato que permite identificar
claramente distintos tipos de objetos, algo especialmente útil en Internet, donde cada día
interactúan millones de personas y aplicaciones ‒que también suelen intercambiar infinidad de
recursos. Asignarles un código de identificación exclusivo evita confusiones y garantiza que
todos los implicados se refieran al mismo objeto.
14
Para ello, el identificador del objeto debe basarse en un sistema fiable y ser permanente, es
Página
decir, no incluir datos de ubicación ni de tiempo. El URN se adapta a este requisito a la
perfección, porque se puede utilizar indefinidamente, sin importar el lugar donde
se encuentre el objeto: en otras palabras, el identificador no varía, aunque el recurso se
traslade y almacene en un lugar distinto.
Diferencias entre URN, URL y URI:
El URN o uniform resource name tiene algo en común con el URL o uniform resource locator:
ambos son subcategorías del URI o uniform resource identifier. Este formato fue concebido
para identificar y acceder a todo tipo de recursos en redes como Internet, desde páginas web
hasta direcciones de correo electrónico. Esto también se aplica al URL y al URN, que, a pesar
de sus particularidades, presentan la misma estructura que el URI.
Sin embargo, ambos formatos difieren en que el URN añade un identificador permanente a un
recurso, mientras que el URL se limita a indicar su localización. Mientras que el URN está
diseñado para ser invariable e independiente del lugar donde se almacenen los datos, el URL
indica la ubicación concreta donde se encuentra el recurso. Por lo tanto, ambas secuencias
tienen una estructura similar, pero diferentes propósitos.
15
Página
CONCLUSIONES
✓ Creamos un servicio para ser utilizado en un Registro.
✓ Hicimos un servicio para ser utilizado en un Inicio de Sesión.
✓ Realizamos validaciones de verificación correctamente.
✓ Utilizamos Herramientas de Versionamiento.
✓ Instalamos Postman.
✓ Se realizo el Testing de la API construida usando la herramienta Postman.
✓ Grabamos un video para mostrar el testing con Postman.
✓ Entregamos ENDPOINT de la API.
✓ Realizamos los servicios necesarios para cumplir las características del
software.
✓ Creamos documentación de cada uno de los servicios.
16
Página
REFERENCIAS
[Link]
Tecnologia/228118/Contenido/OVA/CF33/[Link]#/introduccion
[Link]
[Link]
[Link]
17
Página