radex

v0.1.0

radex v0.1.0 Radex.Writer View Source

Write documentation based on the metadata stored

Link to this section Summary

Functions

example_file_path(example)

Generate a file path for an example

write!(metadata, path)

Generate the index and all example files

Link to this section Functions

Link to this function example_file_path(example) View Source 
example_file_path(map) :: String.t

Generate a file path for an example

iex> example = %{metadata: %{resource: "Orders", description: "Creating an order"}}
iex> Radex.Writer.example_file_path(example)
"orders/creating_an_order.json"
Link to this function write!(metadata, path) View Source

Generate the index and all example files