Crear probador de API utilizando el módulo de requests de Python

Requisitos previos: Módulo de requests de Python , API

En este artículo, analizaremos el proceso de trabajo del módulo de requests de Python mediante la creación de un probador de API.

API significa Interfaz de programación de aplicaciones (participante principal de toda la interactividad). Es como un mensajero que lleva nuestras requests a un sistema y nos devuelve una respuesta a través de una conectividad perfecta. Usamos API en muchos casos para obtener datos para una aplicación web o para conectarnos a un servidor remoto que tiene datos como el clima que cambia constantemente o para permitir que dos aplicaciones intercambien datos entre sí.

La biblioteca de requests es una parte integral de Python para realizar requests HTTP a una URL específica. Ya sea que se trate de API REST o Web Scrapping, las requests deben aprenderse para continuar con estas tecnologías. Cuando uno realiza una solicitud a un URI, devuelve una respuesta. Las requests de Python proporcionan funcionalidades integradas para administrar tanto la solicitud como la respuesta.

Enfoque paso a paso:

  • Primero, elegimos la entrada del usuario lo que quiere.
  • Tome una URL de entrada.

Si el usuario elige Solicitud GET.

  • En la función getReq() , realice una solicitud GET utilizando el módulo Requests y almacene el resultado.
  • Formatea el resultado usando el módulo JSON y devuélvelo.

Si el usuario elige Publicar solicitud.

  • Tome un diccionario de datos para enviar al servidor.
  • En la función postReq() , realice una solicitud POST con datos JSON utilizando el módulo Solicitud y almacene el resultado.
  • Formatea el resultado usando el módulo JSON y devuélvelo.

Finalmente, imprima el resultado devuelto.

A continuación se muestra la implementación basada en el enfoque anterior:

Python3

# request module to
# work with api's
import requests
 
# json module to
# parse and get json
import json
 
 
# This function are return the
# json response from given url
def getReq(url):
     
    # handle the exceptions
    try:
       
        # make a get request using requests
        # module and store the result.
        res = requests.get(url)
         
        # return the result after
        # formatting in json.
        return json.dumps(res.json(), indent=4)
    except Exception as ee:
        return f"Message : {ee}"
 
       
# This function are return the
# json response of url and json
# data you send the server  
def postReq(url, data):
   
    # handle the exceptions
    try:
       
        # make a post request with
        # the json data
        res = requests.post(url, json=data)
         
        # return the response after
        # formatting in json.
        return json.dumps(res.json(), indent=4)
    except Exception as er:
        return f"Message : {er}"
 
       
# Driver Code
if __name__ == '__main__':
   
    # always run loop to make
    # menu driven program
    while True:
       
        # handle the exceptions
        try:
            choice = int(input("1.Get Request\n2.Post Request\n3.Exit\nEnter Choice : "))
             
            # get user choice and perform tasks.
            if choice == 1:
               
                # take a url as a input.
                url_inp = input("Enter a valid get url : ")
                 
                # print the result of the url.
                print(getReq(url_inp))
                 
            elif choice == 2:
               
                # take a url as a input
                url_inp = input("Enter a valid get url : ")
                 
                # take a formal data as input in dictionary.
                data_inp = {
                    "name": input("Name : "),
                    "email": input("Email : "),
                    "work": input("Work : "),
                    "age": input("Age : ")
                }
                 
                # print the result.
                print(postReq(url_inp, data_inp))
                 
            elif choice == 3:
               
                # if user want to exit.
                exit(0)
                 
        except Exception as e:
            print("Error : ", e)

Producción:

Primero, haga la solicitud de obtención

Una solicitud get con la consulta.

Una solicitud de obtención para obtener todos los usuarios.

Por último, realice una solicitud posterior con datos JSON.

A continuación se muestra el video de salida completo para representar la funcionalidad del programa

Publicación traducida automáticamente

Artículo escrito por mrsuryapratap y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *