Packages

xcribe

0.0.2
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
0 Dependencies
Dependants
Files
Activity
xcribe lib api_blueprint templates.ex
Raw

lib/api_blueprint/templates.ex 

defmodule Xcribe.ApiBlueprint.Templates do

  defmacro __using__(_opts \\ []) do

    quote do

      @overview_template """

      FORMAT: 1A

      HOST: --host--



      # --name--

      --description--



      """

      @group_template "## Group --group_name--\n"

      @resource_template "## --resource_name-- --resource_path--\n"

      @parameters_template "+ Parameters\n\n--parameters_list--\n"

      @item_template "--prefix----param--: `--value--` (--type--) - --description--\n"

      @action_template "### --resource_name-- --action_name-- --resource_path--\n"

      @attributes_template "    + Attributes\n\n--attributes_list--\n"

      @headers_template "    + Headers\n\n--headers--\n"

      @header_item_template "            --header--: --value--\n"

      @request_template "+ Request --description-- (--content_type--)\n"

      @response_template "+ Response --code-- (--content_type--)\n"

      @body_template "    + Body\n\n--body--\n"

    end

  end

end