使用django创建简单的json api
django-simple-json-api的Python项目详细描述
django简单json api
安装
pip install django-simple-json-api
说明
将dsjapi.decorators.api或dsjapi.decorators.api_rq添加到视图函数中。
返回json可序列化对象或django.http.HttpResponse对象。
引发dsjapi.exceptions.ServerException异常将自动返回相应的json响应。
装饰器参数
fielddsjapi.fields.Field
请求正文中应有字段。默认值是None。allowedMethodslist的str
允许的http方法（大写）。默认值是["GET", "POST"]。safeEncodingboolTrue允许非dict响应对象。默认值是False。
@api与@api_rq
@api只提供已验证的请求数据。@api_rq提供一个dsjapi.decorators.Request对象，该对象同时包含request（原始django.http.HttpRequest对象）和data（已验证的请求数据）属性。
示例
视图
fromdsjapi.decoratorsimportapifromdsjapi.fieldsimport*@api(DictField({"name":StringField(minLength=2,maxLength=32,regex=r'^[a-zA-Z ]+$'),"bio":StringField(maxLength=64,missing=Field.Do.DEFAULT,default=""),# Optional (default to "")"age":IntField(min=18,max=130)}))defindex(data):result=putUser(data["name"],data["bio"],data["age"])return{"result":result}
fromdsjapi.decoratorsimportapifromdsjapi.fieldsimport*@api(DictField({"start":ListField.byLength(2,FloatField()),"end":ListField.byLength(2,FloatField(),missing=Field.Do.SKIP),# Optional"time":FloatField(min=120,max=60*60)}))defindex(data):if"end"indata:route=getARoute(data["start"],data["time"])else:route=getABRoute(data["start"],data["end"],data["time"])return{"route":route}
fromdsjapi.decoratorsimportapifromdsjapi.fieldsimport*@api(DictField({"numbers":ListField.byLength(2,FloatField(min=0))}))defindex(data):sum=0fornumberindata["numbers"]:sum+=numberavg=sum/len(data["numbers"])return{"average":avg}
fromdsjapi.decoratorsimportapifromdsjapi.fieldsimport*fromdsjapi.exceptionsimport*@api(DictField({"id":IntField(min=0,max=4096),"password":StringField(min=8,max=32)}))defindex(data):user=getUserById(data["id"])ifuserisNone:raiseNotFoundException("User not found")ifuser.getPassword()!=data["password"]:raiseAuthenticationException("Wrong password")return{"id":user.getId(),"score":user.getScore()}
自定义字段
fromdsjapi.fieldsimportIntField,FieldExceptionclassEvenNumberField(IntField):def__init__(self,min=None,max=None,missing=Field.Do.RAISE,error=Field.Do.RAISE,default=None):super().__init__(int,min=min,max=max,missing=missing,error=error,default=default)defclean(self,value):value=super().clean(value)ifvalue%2!=0:raiseFieldException("Odd number")returnvalue
欢迎加入QQ群-->： 979659372
