responser

Responsabilidad

Responser es un paquete de Python para convertir cadenas normales, objetos y otros datos para REST Convención de respuesta de API y en formato JSON.

Uso

Responser

---

Responser es un paquete de Python para convertir cadenas normales, objetos y otros datos para REST Convención de respuesta de API y en formato JSON.

Esta función sigue la siguiente estructura JSON.

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " OK "
}

JSONResponser

• Importar la función con from responser import JSONResponser
• Definición JSONResponser(status_code=400, data=None, message=None, strict_mode=false)
• status_code puede ser códigos de estado HTTP o sus propios códigos de estado personalizados.
• Si el status_code es un código de estado HTTP y los data son None , se agrega una frase de la razón predeterminada. (Si strict_mode es False (predeterminado))
• Si el status_code es un código de estado HTTP y el message es None , se agrega una frase de la razón predeterminada. (Incluso si strict_mode es True (predeterminado)).
• Si el status_code no es un código de estado HTTP y los data son None , se agregan datos vacíos.
• Si el status_code no es un código de estado HTTP y el message es None , se agrega un mensaje vacío.
• Si el strict_mode se establece en True , los datos dados como data están codificados.
• El status_code predeterminado a 400.

Código de muestra

 from responser import JSONResponser

status_code = 200
data = {
    "name" : "Bharath Kumar Ravichandran" ,
    "alma_mater" : "NIT Trichy" ,
    "languages_known" : [
        "Python" ,
        "PHP" ,
        "JS" ,
        "C++"
    ],
    "cool_guy" : "yes" ,
}
message = "User details returned."

response = JSONResponser ( status_code , data , message )
print response

Producción

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " User details returned. "
}

JSONResponserDecorator

• Importar el decorador de from responser import JSONResponserDecorator
• Función de envoltura con decorador @JSONResponserDecorator
• JSONResponserDecorator está construido sobre JsonResponser, por lo que sigue la misma convención que JSONResponser .

Código de muestra

 from responser import JSONResponserDecorator

@ JSONResponserDecorator
def sample_function ():

    data = {
        "name" : "Bharath Kumar Ravichandran" ,
        "alma_mater" : "NIT Trichy" ,
        "languages_known" : [
            "Python" ,
            "PHP" ,
            "JS" ,
            "C++"
        ],
        "cool_guy" : "yes" ,
    }

    return data

Datos devueltos

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " OK "
}

Inspirado desde

Gokulsrinivas/sangría

Colaboradores

Bharath Kumar Ravichandran

Licencia

MIT