用于api的数据验证和rest自动文档管理器。
restifier的Python项目详细描述
restifer是一个python库,用于创建和记录restful
原料药。
它包括一个中间件组件、一组装饰器和一个“表单”
用于验证/记录请求的库。中间产生一个
自动为api提供与swagger兼容的json规范。
许可证
麻省理工学院的执照
用法
有关用法的信息,请参见tests.py。一般来说,创建一个有效负载 验证器构造这样的类:
classHelloMessage(Message):greeting=StringProperty(description="The greating.",validators=[regex(re.compile('^[A-Za-z]+$')),required()])classHelloResponseMessage(Message):salutation=StringProperty(description="The response.")tags=StringProperty(repeated=True)request=StructuredProperty(HelloMessage)
然后像这样装饰您的处理程序:
classHelloHandler(RequestHandler):@api(input=HelloMessage,output=HelloResponseMessage)defpost(self,obj):return{'salutation':'You are the best.'}
另外,要自动记录,请使用中间件:
routes=[('/api/v1/hello',HelloHandler)]app=DocumentedMiddleware(WSGIApplication(routes),api_base="/api/v1",api_overview="This is a super important API that does a lot of stuff.")