View Source OpenApiSpex.Plug.PutApiSpec (open_api_spex v3.18.0)
Module plug that calls a given module to obtain the Api Spec and store it as private in the Conn.
This allows downstream plugs to use the API spec for casting, validating and rendering.
options
Options
- module: A module implementing the
OpenApiSpex.OpenApi
behaviour
example
Example
plug OpenApiSpex.Plug.PutApiSpec, module: MyAppWeb.ApiSpec
Link to this section Summary
Link to this section Functions
@spec get_and_cache_controller_action(Plug.Conn.t(), String.t(), {module(), atom()}) :: OpenApiSpex.Operation.t()
@spec get_spec_and_operation_lookup(Plug.Conn.t()) :: {spec :: OpenApiSpex.OpenApi.t(), operation_lookup :: %{required(any()) => OpenApiSpex.Operation.t()}}
@spec spec_module(Plug.Conn.t()) :: module()