(Quick Reference)

ApiResponse

Purpose

Documents a error response code

Usage

Simple Usage

@ApiResponse(code=404, message="These are not the droid you're looking for", response=CustomErrorClass)

Parameters

ParameterSupportedUsage
codeYesThe HTTP code in question
messageYesThe correct interpretation of this code
responseYesThe data type of the response during this code