Packages

xcribe

0.7.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
1 Dependency
Dependants
Files
Activity
xcribe lib api_blueprint api_blueprint.ex
Raw

lib/api_blueprint/api_blueprint.ex 

defmodule Xcribe.ApiBlueprint do

  @moduledoc false



  alias Xcribe.ApiBlueprint.{APIB, Formatter}

  alias Xcribe.{Config, DocException}



  def generate_doc(requests) do

    requests

    |> apib_struct()

    |> APIB.encode()

  end



  def apib_struct(requests) do

    Map.put(

      xcribe_info(),

      :groups,

      reduce_groups(requests)

    )

  end



  defp reduce_groups(requests), do: Enum.reduce(requests, %{}, &format_and_merge/2)



  defp format_and_merge(request, acc) do

    item = Formatter.full_request_object(request)



    Formatter.merge_request(acc, item)

  rescue

    exception -> raise DocException, {request, exception, __STACKTRACE__}

  end



  defp xcribe_info, do: apply(Config.xcribe_information_source!(), :api_info, [])

end