Skip to content

Instantly share code, notes, and snippets.

@zdne

zdne/outline.markdown

Last active August 29, 2015 14:09
Show Gist options
  • Save zdne/c7029ac0078a427d892e to your computer and use it in GitHub Desktop.
Save zdne/c7029ac0078a427d892e to your computer and use it in GitHub Desktop.
Download ZIP
API Blueprint Outline
Raw
outline.markdown

$KEY: $VALUE

$API_NAME

$DESCRIPTION

group $GROUP_NAME

$DESCRIPTION

$RESOURCE_NAME [$URI_TEMPLATE]

$DESCRIPTION

  • model ($MEDIA_TYPE)

    $DESCRIPTION

    • headers

        $KEY: $VALUE

    • body

        $ASSET_LITERAL

    • schema

        $ASSET_LITERAL

  • parameters

    • $PARAMETER_NAME = $DEFAULT_VALUE (required | optional , $TYPE, $EXAMPLE_VALUE) ... $ DESCRIPTION

      $ DESCRIPTION

      • values
        • $VALUE

$ACTION_NAME [$METHOD]

$DESCRIPTION

  • parameters

    • $PARAMETER_NAME = $DEFAULT_VALUE (required | optional , $TYPE, $EXAMPLE_VALUE) ... $ DESCRIPTION

      $ DESCRIPTION

      • values
        • $VALUE

  • request $REQUEST_NAME ($MEDIA_TYPE)

    $DESCRIPTION

    • headers

        $KEY: $VALUE

    • body

        $ASSET_LITERAL

    • schema

        $ASSET_LITERAL

  • response $STATUS_CODE ($MEDIA_TYPE)

    $DESCRIPTION

    • headers

        $KEY: $VALUE

    • body

        $ASSET_LITERAL

    • schema

        $ASSET_LITERAL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment