responser

Ответчин

Ответчик - это пакет Python для преобразования нормальных строк, объектов и других данных в конвенцию REST API и в формате JSON.

Использование

Responser

---

Ответчик - это пакет Python для преобразования нормальных строк, объектов и других данных в конвенцию REST API и в формате JSON.

Эта функция следует за следующей структурой 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

• Импортировать функцию с from responser import JSONResponser
• Определение JSONResponser(status_code=400, data=None, message=None, strict_mode=false)
• status_code может быть кодами статуса HTTP или вашими собственными пользовательскими кодами состояния.
• Если status_code является кодом состояния HTTP, а data None являются, добавлена ​​фраза по умолчанию. (Если strict_mode является False (по умолчанию))
• Если status_code является кодом состояния HTTP, а message None , добавляется фраза причины по умолчанию. (Даже если strict_mode это True (по умолчанию)).
• Если status_code не является кодом состояния HTTP, а data None , добавляются пустые данные.
• Если status_code не является кодом состояния HTTP, а message None , добавляется пустое сообщение.
• Если strict_mode устанавливается на True , данные, приведенные в виде data , кодируются.
• status_code по умолчанию до 400.

Пример кода

 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

Выход

{
  "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

• Импортируйте декоратор из from responser import JSONResponserDecorator
• Функция обертки с декоратором @JSONResponserDecorator
• JSONResponserDecorator построен на вершине JSonResponser, поэтому он следует той же конвенции, что и JSONResponser .

Пример кода

 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

Возвращаемые данные

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

Вдохновлен от

Gokulsrinivas/Sangria

Участники

Бхарат Кумар Равичандран

Лицензия

Грань