Skip to content


Route descriptions#

Summary and descriptions are extracted from the comments above the function that represents the route.

  • the first line of the comment is used as a summary
  • if there are multiple lines then all the lines are used as a description
class Comments < AC::Base
  base "/comments"

  # This is a route summary
  def index; end

  # This is a route summary
  # This is a route description
  # and the description continued
  def create; end

Map POST data#

class Articles < AC::Base
  base "/articles"

  @[AC::Route::POST("/", body: :article)]
  def create(article : Article); end