RouteModel

fastapi_gateway_auto_generate.domain.models.RouteModel.RouteModel dataclass

A data class for storing data about a microservice.

Parameters:

Name	Type	Description	Default
request_method	Any	Is a callable (like app.get, app.post and so on.)	required
gateway_path	str	Is the path to bind gateway.	required
service_url	str	Is url path to microservice (like "https://api.example.com/v1")	required
service_path	str	The path to the endpoint on another service.	required
query_params	Optional[List[str]]	Used to extract query parameters from endpoint and transmission to microservice	None
query_required	Optional[List[bool]]	Defines whether the specified parameters are mandatory for the request to the microservice.	None
query_is_cookie	Optional[List[bool]]	Determines whether the specified parameters should be passed as a cookie.	None
form_params	Optional[List[str]]	Used to extract form model parameters from endpoint and transmission to microservice	None
body_params	Optional[List[str]]	Used to extract body model from endpoint and transmission to microservice	None
tags	Optional[List[str]]	Allows grouped objects in the api docs	None
dependencies	Optional[str]	See documentation for details - https://fastapi.tiangolo.com/tutorial/dependencies/#declare-the-dependency-in-the-dependant	None