Packages

xcribe

0.1.0
0.7.12 0.7.11 0.7.10 0.7.9 0.7.8 0.7.7 0.7.6 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0 0.0.2 0.0.1

A lib to generate API documentation from test specs

HexDocs

Current section

Files

Jump to
Readme
23 Versions
0 Dependencies
Dependants
Files
Activity
xcribe lib config.ex
Raw

lib/config.ex 

defmodule Xcribe.Config do

  @valid_formats [:api_blueprint, :swagger]

  def output_file, do: Application.get_env(:xcribe, :output_file, default_output_file())



  def doc_format do

    :xcribe

    |> Application.get_env(:doc_format, :api_blueprint)

    |> validate_doc_format()

  end



  def active?, do: !is_nil(System.get_env(env_var_name()))



  def xcribe_information_source,

    do: Application.fetch_env!(:xcribe, :information_source)



  defp env_var_name, do: Application.get_env(:xcribe, :env_var, "XCRIBE_ENV")



  defp default_output_file() do

    case doc_format() do

      :api_blueprint -> "api_doc.apib"

      :swagger -> "openapi.json"

      _ -> ""

    end

  end



  defp validate_doc_format(format) when format in @valid_formats, do: format

  defp validate_doc_format(_), do: :error

end