AutoDoc v0.0.1 AutoDoc

Summary

Functions

This function registers a before_send callback that will record the API interactions

Starts the AutoDoc.Agent to record all the API interactions. It’s just a wrapper around Application.ensure_all_started(:auto_doc)

Functions

document_api(conn, test_name)

Specs

document_api(Plug.Conn.t, binary) :: no_return

This function registers a before_send callback that will record the API interactions.

Examples

setup context do
  conn =
    conn()
    |> AutoDoc.document_api(context[:test])
  {:ok, conn: conn}
end
start()

Starts the AutoDoc.Agent to record all the API interactions. It’s just a wrapper around Application.ensure_all_started(:auto_doc).