sanic-attrs 0.2.1

SANIC和ATTS支持Swagger 2.0/OpenAPI

使用以下功能增强您的应用程序：

• 属性
• 招摇过市

注意：这是sanic openapi实现的一个分支，来自@channelcat，我非常喜欢它，但它缺少我想要的一些功能（我还使用了第三方库（attrs）作为建模输入/输出模型类的默认值。

超快介绍

给你的sanic api一个ui和openapi文档，一切都是免费的！

安装

注意：由于这个fork是我的必需品，我想实现的许多功能仍然不可用，因此这个库的状态是pre alpha！另外，不要尝试examples文件夹，它还没有转换！我真丢脸……

pip install sanic-attrs

添加openapi和swagger ui:

fromsanic_attrsimportswagger_blueprint,openapi_blueprintapp.blueprint(openapi_blueprint)app.blueprint(swagger_blueprint)

现在，您将在url/swagger处拥有一个swagger用户界面。你的路线将根据蓝图自动分类。这是默认用法，但可以看到更高级的用法。继续读下去！

注意：swagger_blueprint非常棒，但有时您不希望它以任何原因（安全性等）打开，因此您只能在运行debug=true时才能使用它。我就是这么用的：微笑：

输入

当然，由于sanic attrs是基于attrs的，而python的目标版本是3.5+，因此模型的大多数类型定义都将完全使用python类型，要么是全局类型，要么是来自typing库。此外，还支持枚举！：火花：

以下是支持的类型（到目前为止）：

• int
• 浮点数
• str
• bool
• 日期
• 日期时间
• 字节
• 键入.any
• 键入.collection
• 键入.dict
• 键入.iterable
• 键入.list
• 键入.mapping
• 键入。可选
• 键入.sequence
• 键入.set
• 键入.union

关于列表和dict的说明：请使用typing.list和typing.dict进行此操作。

用法

使用简单的修饰符记录路由

fromsanic_attrsimportdoc@app.get("/user/<user_id:int>")@doc.summary("Fetches a user by ID")@doc.produces(SomeOutputModel)asyncdefget_user(request,user_id):...@app.post("/user")@doc.summary("Creates a user")@doc.consumes(SomeInputModel,location="body")asyncdefcreate_user(request):...

为输入/输出建模

是的，在此版本中，您需要具有描述性：wink:

importtypingfromsanic_attrsimportdocclassCar(doc.Model):make:str=doc.field(description="Who made the car")model:str=doc.field(description="Type of car. This will vary by make")year:int=doc.field(description="4-digit year of the car",required=False)classGarage(doc.Model):spaces:int=doc.field(description="How many cars can fit in the garage")cars:typing.List[Car]=doc.field(description="All cars in the garage")@app.get("/garage")@doc.summary("Gets the whole garage")@doc.produces(Garage)asyncdefget_garage(request):returnjson({"spaces":2,"cars":[{"make":"Nissan","model":"370Z"}]})

高级用法

硅ncedoc.model和doc.field对于@attr.sdecorator和attr.ib函数来说只是语法糖，您可以使用这些提供的类和方法来表示模型，或者在模型中使用vanillaattr。下面是一个复杂的示例，它显示了一个混合模型：

fromenumimportEnum,IntEnumfromtypingimport(Any,Collection,Dict,Iterable,List,Mapping,Optional,Sequence,Set,Union)importattrfromsanic_attrsimportdocclassPlatformEnum(str,Enum):XBOX1="XBOX1"PLAYSTATION4="PLAYSTATION4"PC="PC"classLanguageEnum(IntEnum):ENGLISH=1JAPANESE=2SPANISH=3GERMAN=4PORTUGUESE=5classSomething(doc.Model):some_name:str=doc.field(description="Something name")@attr.sclassAnotherSomething:another_name:str=attr.ib(metadata={"description":"Another field"})classGame(doc.Model):name:str=doc.field(description="The name of the game")platform:PlatformEnum=doc.field(description="Which platform it runs on")score:float=doc.field(description="The average score of the game")resolution_tested:str=doc.field(description="The resolution which the game was tested")genre:List[str]=doc.field(description="One or more genres this game is part of")genre_extra:Sequence[str]=doc.field(description="One or more genres this game is part of")rating:Dict[str,float]=doc.field(description="Ratings given on each country")rating_outside:Mapping[str,float]=doc.field(description="Ratings given on each country")screenshots:Set[bytes]=doc.field(description="Screenshots of the game")screenshots_extra:Collection[bytes]=doc.field(description="Screenshots of the game")players:Iterable[str]=doc.field(description="Some of the notorious players of this game")review_link:Optional[str]=doc.field(description="The link of the game review (if exists)")junk:Union[str,bytes]=doc.field(description="This should be strange")more_junk:Any=doc.field(description="The more junk field")language:LanguageEnum=doc.field(description="The language of the game")something:List[Something]=doc.field(description="Something to go along the game")another:AnotherSomething=doc.field(description="Another something to go along the game")

关于输入提示或类型参数的说明

您可能已经注意到，在上面的示例中，所有变量都是使用键入提示创建的。虽然这有点有趣，但您可能还想使用type参数，这是attr包提供的，而且sanic attrs完全可以。因此，我们的游戏类更希望如下所示：

classGame(doc.Model):name=doc.field(type=str,description="The name of the game")platform=doc.field(type=PlatformEnum,description="Which platform it runs on")score=doc.field(type=float,description="The average score of the game")resolution_tested=doc.field(type=str,description="The resolution which the game was tested")genre=doc.field(type=List[str],description="One or more genres this game is part of")genre_extra=doc.field(type=Sequence[str],description="One or more genres this game is part of")rating=doc.field(type=Dict[str,float],description="Ratings given on each country")rating_outside=doc.field(type=Mapping[str,float],description="Ratings given on each country")screenshots=doc.field(type=Set[bytes],description="Screenshots of the game")screenshots_extra=doc.field(type=Collection[bytes],description="Screenshots of the game")players=doc.field(type=Iterable[str],description="Some of the notorious players of this game")review_link=doc.field(type=Optional[str],description="The link of the game review (if exists)")junk=doc.field(type=Union[str,bytes],description="This should be strange")more_junk=doc.field(type=Any,description="The more junk field")language=doc.field(type=LanguageEnum,description="The language of the game")something=doc.field(type=List[Something],description="Something to go along the game")another=doc.field(type=AnotherSomething,description="Another something to go along the game")

关于attrs

fromsanic_attrsimportparser_blueprint# ...app.blueprint(parser_blueprint)# ...@app.post("/game",strict_slashes=True)@doc.summary("Inserts the game data into the database")@doc.response("200","Game inserted successfuly",model=SuccessOutput)@doc.response("403","The user couldn't insert game to application",model=ErrorOutput)@doc.consumes(Game,location="body",content_type="application/json")@doc.produces(SuccessOutput)asyncdefinsert_game(request):my_object=request["input_obj"]assertisinstance(my_object,Game)# your logic here

fromsanic.responseimportjsonfromsanic_attrsimportparser_blueprint# ...app.blueprint(parser_blueprint)# ...@app.middleware("request")asyncdefcheck_if_input_is_none(request):if"input_obj"inrequest:ifrequest["input_obj"]isNone:# error handling herereturnjson({"error":request["input_exc"].args[0]},500)

fromsanic_attrsimportresponse# ...@app.get("/game",strict_slashes=True)@doc.summary("Gets the most played game in our database")@doc.response("200","Game data",model=Game)@doc.response("403","The user can't access this endpoint",model=ErrorOutput)@doc.produces(Game)asyncdefget_game(request):game=Game(name="Cities: Skylines",platform="PC",score=9.0,resolution_tested="1920x1080",genre=["Simulators","City Building"],rating={"IGN":8.5,"Gamespot":8.0,"Steam":4.5},players=["Flux","strictoaster"],language=1)returnresponse.model(game)# <--- the game instance, to be further serialized

pip install sanic-attrs