Prefer using HTTP status code symbols

Docs > コード分析 > Static Analysis Rules > Prefer using HTTP status code symbols

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Metadata

ID: rails-best-practices/http-status-code-symbols

Language: Ruby

Severity: Notice

Category: Best Practices

Description

This rule encourages the use of symbolic representations of HTTP status codes over their numeric counterparts, making the code more self-explanatory and easier to understand. Numeric HTTP status codes can be cryptic and hard to remember, especially for developers who are not familiar with them.

To adhere to this rule, simply replace the numeric HTTP status code with its symbolic equivalent in your code. For example, instead of using 403 for a forbidden request, use :forbidden.

Non-Compliant Code Examples

class ApplicationController < ActionController::Base
  def access_denied
    render status: 403 # Avoid using numeric HTTP status code
  end
end

Compliant Code Examples

class ApplicationController < ActionController::Base
  def access_denied
    render status: :forbidden
  end
end