open_api_spex v3.10.0

OpenApiSpex.Plug.Cache behaviour (open_api_spex v3.10.0) View Source

Cache for OpenApiSpex

Settings:

config :open_api_spex, :cache_adapter, Module

There are already had three cache adapter:

  • OpenApiSpex.Plug.PersistentTermCache - default
  • OpenApiSpex.Plug.AppEnvCache - if VM not supported persistent_term
  • OpenApiSpex.Plug.NoneCache - none cache

If you are constantly modifying specs during development, you can setting like this in dev.exs:

config :open_api_spex, :cache_adapter, OpenApiSpex.Plug.NoneCache

Link to this section Summary

Functions

adapter()

Get cache adapter

refresh()

Only erase cache, put again when plug starting

Callbacks

erase(module)
get(module)
put(module, {})

Link to this section Functions

Link to this function

adapter()

View Source

Specs

adapter() :: module()

Get cache adapter

Link to this function

refresh()

View Source

Specs

refresh() :: :ok

Only erase cache, put again when plug starting

Link to this section Callbacks

Link to this callback

erase(module)

View Source

Specs

erase(module()) :: :ok
Link to this callback

get(module)

View Source

Specs

get(module()) :: {OpenApiSpex.OpenApi.t(), map()} | nil
Link to this callback

put(module, {})

View Source

Specs

put(module(), {OpenApiSpex.OpenApi.t(), map()}) :: :ok