Xcribe v0.7.0 Xcribe.Information View Source

Add custom information for your API documentation.

You must create a module to handle custom information about your API. That module must use Xcribe.Information.

defmodule YourModuleInformation do
  use Xcribe.Information
end

The basic information is required and must be given inside xcribe_info block.

  xcribe_info do
    name "Your awesome API"
    description "The best API in the world"
    host "http://your-api.us"
  end

Link to this section Summary

Functions

Defines the API custom information.

Link to this section Functions

Link to this macro

xcribe_info(list)

View Source (macro)

Defines the API custom information.

This information will be used to build the final documentation.

The required info are:

  • name - a name for your API.
  • description - a description about your API.
  • host - your API host url

Example:

defmodule YourModuleInformation do
  use Xcribe.Information

  xcribe_info do
    name "Your awesome API"
    description "The best API in the world"
    host "http://your-api.us"
  end
end