Skip to content

SpecificationFactory

faststream.specification.base.SpecificationFactory #

Bases: Protocol

title instance-attribute #

title

description instance-attribute #

description

version instance-attribute #

version

contact instance-attribute #

contact

license instance-attribute #

license

add_broker abstractmethod #

add_broker(broker)
Source code in faststream/specification/base/generator.py 
21
22
23
24
25
26
27
@abstractmethod
def add_broker(
    self,
    broker: "BrokerUsecase[Any, Any]",
    /,
) -> "SpecificationFactory":
    raise NotImplementedError

add_http_route abstractmethod #

add_http_route(path, handler)
Source code in faststream/specification/base/generator.py 
29
30
31
32
33
34
35
@abstractmethod
def add_http_route(
    self,
    path: str,
    handler: "HttpHandler",
) -> "SpecificationFactory":
    raise NotImplementedError

to_specification abstractmethod #

to_specification()
Source code in faststream/specification/base/generator.py 
37
38
39
@abstractmethod
def to_specification(self) -> Specification:
    raise NotImplementedError