BlueBird v0.4.0 BlueBird.Writer
Writes api documentations in apib and swagger format to files.
Link to this section Summary
Functions
Writes a BlueBird.ApiDoc{}
struct to apib and swagger files
Link to this section Functions
Link to this function
run(api_docs)
run(api_docs)
run(BlueBird.ApiDoc.t()) :: :ok | {:error, File.posix()}
run(BlueBird.ApiDoc.t()) :: :ok | {:error, File.posix()}
Writes a BlueBird.ApiDoc{}
struct to apib and swagger files.
This function will be called automatically by BlueBird.Formatter
after
every test run.
You can set the destination directory in config.exs
.
config :blue_bird,
docs_path: "priv/static/docs"
Link to this function
run_apib(api_docs, filename)
run_apib(api_docs, filename)
run_apib(BlueBird.ApiDoc.t(), String.t()) :: {:error, File.posix()}
run_apib(BlueBird.ApiDoc.t(), String.t()) :: {:error, File.posix()}
Link to this function
run_swagger(api_docs, filename)
run_swagger(api_docs, filename)
run_swagger(BlueBird.ApiDoc.t(), String.t()) :: {:error, File.posix()}
run_swagger(BlueBird.ApiDoc.t(), String.t()) :: {:error, File.posix()}