[要約] RFC 7807は、HTTP APIの問題の詳細を提供するための仕様であり、エラーレスポンスの標準化を目的としています。この仕様は、APIの開発者とクライアント間のコミュニケーションを改善し、問題の特定と解決を容易にすることを目指しています。
Internet Engineering Task Force (IETF) M. Nottingham
Request for Comments: 7807 Akamai
Category: Standards Track E. Wilde
ISSN: 2070-1721 March 2016
Problem Details for HTTP APIs
HTTP APIの問題の詳細
Abstract
概要
This document defines a "problem detail" as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs.
このドキュメントでは、HTTP APIの新しいエラー応答フォーマットを定義する必要をなくすために、HTTP応答でマシンが読み取り可能なエラーの詳細を伝える方法として「問題の詳細」を定義しています。
Status of This Memo
本文書の状態
This is an Internet Standards Track document.
これはInternet Standards Trackドキュメントです。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 5741.
このドキュメントは、IETF（Internet Engineering Task Force）の製品です。これは、IETFコミュニティのコンセンサスを表しています。公開レビューを受け、インターネットエンジニアリングステアリンググループ（IESG）による公開が承認されました。インターネット標準の詳細については、RFC 5741のセクション2をご覧ください。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7807.
このドキュメントの現在のステータス、エラータ、およびフィードバックの提供方法に関する情報は、http：//www.rfc-editor.org/info/rfc7807で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2016 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
この文書は、BCP 78およびこの文書の発行日に有効なIETF文書に関するIETFトラストの法的規定（http://trustee.ietf.org/license-info）の対象となります。これらのドキュメントは、このドキュメントに関するあなたの権利と制限を説明しているため、注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、Trust Legal Provisionsのセクション4.eに記載されているSimplified BSD Licenseのテキストが含まれている必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。
Table of Contents
目次
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Requirements . . . . . . . . . . . . . . . . . . . . . . . . 3
3. The Problem Details JSON Object . . . . . . . . . . . . . . . 3
3.1. Members of a Problem Details Object . . . . . . . . . . . 5
3.2. Extension Members . . . . . . . . . . . . . . . . . . . . 6
4. Defining New Problem Types . . . . . . . . . . . . . . . . . 6
4.1. Example . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2. Predefined Problem Types . . . . . . . . . . . . . . . . 8
5. Security Considerations . . . . . . . . . . . . . . . . . . . 8
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
6.1. application/problem+json . . . . . . . . . . . . . . . . 9
6.2. application/problem+xml . . . . . . . . . . . . . . . . . 10
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.1. Normative References . . . . . . . . . . . . . . . . . . 11
7.2. Informative References . . . . . . . . . . . . . . . . . 12
Appendix A. HTTP Problems and XML . . . . . . . . . . . . . . . 14
Appendix B. Using Problem Details with Other Formats . . . . . . 15
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 16
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 16
HTTP [RFC7230] status codes are sometimes not sufficient to convey enough information about an error to be helpful. While humans behind Web browsers can be informed about the nature of the problem with an HTML [W3C.REC-html5-20141028] response body, non-human consumers of so-called "HTTP APIs" are usually not.
HTTP [RFC7230]ステータスコードは、役立つエラーに関する十分な情報を伝えるのに十分でない場合があります。 Webブラウザーの背後にいる人間は、HTML [W3C.REC-html5-20141028]応答本文の問題の性質について通知を受けることができますが、いわゆる「HTTP API」の人間以外のコンシューマーは通常通知されません。
This specification defines simple JSON [RFC7159] and XML [W3C.REC-xml-20081126] document formats to suit this purpose. They are designed to be reused by HTTP APIs, which can identify distinct "problem types" specific to their needs.
この仕様では、この目的に合わせてシンプルなJSON [RFC7159]およびXML [W3C.REC-xml-20081126]ドキュメント形式を定義しています。それらは、HTTP APIによって再利用されるように設計されており、HTTP APIは、ニーズに固有の「問題タイプ」を識別することができます。
Thus, API clients can be informed of both the high-level error class (using the status code) and the finer-grained details of the problem (using one of these formats).
したがって、APIクライアントは、（ステータスコードを使用して）高レベルのエラークラスと（これらの形式のいずれかを使用して）問題のより詳細な詳細の両方を通知できます。
For example, consider a response that indicates that the client's account doesn't have enough credit. The 403 Forbidden status code might be deemed most appropriate to use, as it will inform HTTP-generic software (such as client libraries, caches, and proxies) of the general semantics of the response.
たとえば、クライアントのアカウントに十分なクレジットがないことを示す応答を考えます。 403 Forbiddenステータスコードは、HTTP汎用ソフトウェア（クライアントライブラリ、キャッシュ、プロキシなど）に応答の一般的なセマンティクスを通知するため、使用するのが最も適切であると見なされる場合があります。
However, that doesn't give the API client enough information about why the request was forbidden, the applicable account balance, or how to correct the problem. If these details are included in the response body in a machine-readable format, the client can treat it appropriately; for example, triggering a transfer of more credit into the account.
ただし、これではAPIクライアントに、リクエストが禁止された理由、該当するアカウントの残高、または問題の修正方法に関する十分な情報が提供されません。これらの詳細が機械可読形式で応答本文に含まれている場合、クライアントはそれを適切に処理できます。たとえば、アカウントへのより多くのクレジットの転送をトリガーします。
This specification does this by identifying a specific type of problem (e.g., "out of credit") with a URI [RFC3986]; HTTP APIs can do this by nominating new URIs under their control, or by reusing existing ones.
この仕様は、URI [RFC3986]で特定のタイプの問題（たとえば、「信用できない」）を識別することによってこれを行います。 HTTP APIは、管理下にある新しいURIを指定するか、既存のURIを再利用することで、これを行うことができます。
Additionally, problem details can contain other information, such as a URI that identifies the specific occurrence of the problem (effectively giving an identifier to the concept "The time Joe didn't have enough credit last Thursday"), which can be useful for support or forensic purposes.
さらに、問題の詳細には、問題の特定の発生を識別するURI（ "Joeに先週の木曜日に十分なクレジットがなかった時間"の識別子を効果的に与える）など、サポートに役立つ他の情報を含めることができます。または法医学目的。
The data model for problem details is a JSON [RFC7159] object; when formatted as a JSON document, it uses the "application/problem+json" media type. Appendix A defines how to express them in an equivalent XML format, which uses the "application/problem+xml" media type.
問題の詳細のデータモデルはJSON [RFC7159]オブジェクトです。 JSONドキュメントとしてフォーマットされている場合、「application / problem + json」メディアタイプを使用します。付録Aでは、「application / problem + xml」メディアタイプを使用する同等のXML形式でそれらを表現する方法を定義しています。
Note that problem details are (naturally) not the only way to convey the details of a problem in HTTP; if the response is still a representation of a resource, for example, it's often preferable to accommodate describing the relevant details in that application's format. Likewise, in many situations, there is an appropriate HTTP status code that does not require extra detail to be conveyed.
問題の詳細は（当然）HTTPで問題の詳細を伝える唯一の方法ではないことに注意してください。たとえば、応答が依然としてリソースの表現である場合、多くの場合、そのアプリケーションの形式で関連する詳細の説明に対応することをお勧めします。同様に、多くの状況で、追加の詳細を伝える必要のない適切なHTTPステータスコードがあります。
Instead, the aim of this specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse, tempted to redefine the semantics of existing HTTP status codes. Even if an application chooses not to use it to convey errors, reviewing its design can help guide the design decisions faced when conveying errors in an existing format.
代わりに、この仕様の目的は、エラーを必要とするアプリケーションの一般的なエラー形式を定義することです。これにより、独自のエラー形式を定義する必要がなくなり、既存のHTTPステータスコードのセマンティクスを再定義する必要がなくなります。アプリケーションがエラーを伝えるためにそれを使用しないことを選択した場合でも、その設計を確認することで、既存の形式でエラーを伝えるときに直面する設計上の決定を導くことができます。
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
このドキュメントのキーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」、および「OPTIONAL」は、 [RFC2119]で説明されているように解釈されます。
The canonical model for problem details is a JSON [RFC7159] object.
問題の詳細の正規モデルは、JSON [RFC7159]オブジェクトです。
When serialized as a JSON document, that format is identified with the "application/problem+json" media type.
JSONドキュメントとしてシリアル化される場合、そのフォーマットは「application / problem + json」メディアタイプで識別されます。
For example, an HTTP response carrying JSON problem details:
たとえば、JSON問題の詳細を含むHTTP応答：
HTTP/1.1 403 Forbidden
Content-Type: application/problem+json
Content-Language: en
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"detail": "Your current balance is 30, but that costs 50.",
"instance": "/account/12345/msgs/abc",
"balance": 30,
"accounts": ["/account/12345",
"/account/67890"]
}
Here, the out-of-credit problem (identified by its type URI) indicates the reason for the 403 in "title", gives a reference for the specific problem occurrence with "instance", gives occurrence-specific details in "detail", and adds two extensions; "balance" conveys the account's balance, and "accounts" gives links where the account can be topped up.
ここで、信用できない問題（そのタイプURIで識別）は、「タイトル」の403の理由を示し、「インスタンス」で特定の問題の発生を参照し、「詳細」で発生固有の詳細を示します。 2つの拡張機能を追加します。 「残高」はアカウントの残高を表し、「アカウント」はアカウントにチャージできるリンクを提供します。
The ability to convey problem-specific extensions allows more than one problem to be conveyed. For example:
問題固有の拡張機能を伝達する機能により、複数の問題を伝達できます。例えば：
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
Content-Language: en
{
"type": "https://example.net/validation-error",
"title": "Your request parameters didn't validate.",
"invalid-params": [ {
"name": "age",
"reason": "must be a positive integer"
},
{
"name": "color",
"reason": "must be 'green', 'red' or 'blue'"}
]
}
Note that this requires each of the subproblems to be similar enough to use the same HTTP status code. If they do not, the 207 (Multi-Status) [RFC4918] code could be used to encapsulate multiple status messages.
これは、サブ問題のそれぞれが同じHTTPステータスコードを使用するのに十分類似している必要があることに注意してください。そうでない場合、207（マルチステータス）[RFC4918]コードを使用して、複数のステータスメッセージをカプセル化できます。
A problem details object can have the following members:
問題詳細オブジェクトには、次のメンバーを含めることができます。
o "type" (string) - A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
o "type"（文字列）-問題のタイプを識別するURI参照[RFC3986]。この仕様では、逆参照すると、問題の種類について人間が読める形式のドキュメントが提供されるようになります（たとえば、HTML [W3C.REC-html5-20141028]を使用）。このメンバーが存在しない場合、その値は "about：blank"であると見なされます。
o "title" (string) - A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
o "タイトル"（文字列）-人間が読める形式の問題タイプの概要。ローカリゼーションの目的を除いて、問題の発生ごとに変更するべきではありません（たとえば、事前対応型のコンテンツネゴシエーションを使用します。[RFC7231]、セクション3.4を参照）。
o "status" (number) - The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
o "status"（number）-この問題の発生に対してオリジンサーバーによって生成されたHTTPステータスコード（[RFC7231]、セクション6）。
o "detail" (string) - A human-readable explanation specific to this occurrence of the problem.
o "detail"（文字列）-この問題の発生に固有の、人間が読める説明。
o "instance" (string) - A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
o 「インスタンス」（文字列）-問題の特定の発生を識別するURI参照。逆参照すると、詳細情報が得られる場合と得られない場合があります。
Consumers MUST use the "type" string as the primary identifier for the problem type; the "title" string is advisory and included only for users who are not aware of the semantics of the URI and do not have the ability to discover them (e.g., offline log analysis). Consumers SHOULD NOT automatically dereference the type URI.
消費者は、問題のタイプの主要な識別子として「タイプ」文字列を使用する必要があります。 「タイトル」文字列は参考情報であり、URIのセマンティクスを認識しておらず、それらを検出する機能がないユーザー（オフラインログ分析など）にのみ含まれます。コンシューマはタイプURIを自動的に逆参照しないでください。
The "status" member, if present, is only advisory; it conveys the HTTP status code used for the convenience of the consumer. Generators MUST use the same status code in the actual HTTP response, to assure that generic HTTP software that does not understand this format still behaves correctly. See Section 5 for further caveats regarding its use.
「status」メンバーが存在する場合、それは単なる助言です。コンシューマの便宜のために使用されるHTTPステータスコードを伝えます。ジェネレーターは、実際のHTTP応答で同じステータスコードを使用して、この形式を理解しない一般的なHTTPソフトウェアが引き続き正しく動作することを保証する必要があります。使用に関する注意事項については、セクション5を参照してください。
Consumers can use the status member to determine what the original status code used by the generator was, in cases where it has been changed (e.g., by an intermediary or cache), and when message bodies persist without HTTP information. Generic HTTP software will still use the HTTP status code.
コンシューマーはステータスメンバーを使用して、ジェネレーターで使用された元のステータスコードが変更された場合（中間またはキャッシュなどにより）、メッセージ本文がHTTP情報なしで存続する場合を判別できます。一般的なHTTPソフトウェアは引き続きHTTPステータスコードを使用します。
The "detail" member, if present, ought to focus on helping the client correct the problem, rather than giving debugging information.
「詳細」メンバーが存在する場合、デバッグ情報を提供するのではなく、クライアントが問題を修正するのを支援することに焦点を当てるべきです。
Consumers SHOULD NOT parse the "detail" member for information; extensions are more suitable and less error-prone ways to obtain such information.
消費者は「詳細」メンバーを解析してはなりません。拡張機能は、このような情報を取得するためのより適切でエラーが発生しにくい方法です。
Note that both "type" and "instance" accept relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.
「タイプ」と「インスタンス」はどちらも相対URIを受け入れることに注意してください。つまり、[RFC3986]のセクション5に従って、ドキュメントのベースURIを基準にして解決する必要があります。
Problem type definitions MAY extend the problem details object with additional members.
問題タイプ定義は、追加のメンバーで問題詳細オブジェクトを拡張する場合があります。
For example, our "out of credit" problem above defines two such extensions -- "balance" and "accounts" to convey additional, problem-specific information.
たとえば、上記の「信用不足」問題は、このような2つの拡張機能を定義しています。「残高」と「アカウント」は、問題固有の追加情報を伝えます。
Clients consuming problem details MUST ignore any such extensions that they don't recognize; this allows problem types to evolve and include additional information in the future.
問題の詳細を消費するクライアントは、認識しない拡張機能をすべて無視する必要があります。これにより、問題の種類が進化し、将来的に追加情報が含まれるようになります。
Note that because extensions are effectively put into a namespace by the problem type, it is not possible to define new "standard" members without defining a new media type.
拡張機能は問題のタイプによって事実上ネームスペースに入れられるため、新しいメディアタイプを定義せずに新しい「標準」メンバーを定義することはできないことに注意してください。
When an HTTP API needs to define a response that indicates an error condition, it might be appropriate to do so by defining a new problem type.
HTTP APIがエラー状態を示す応答を定義する必要がある場合は、新しい問題タイプを定義することでそれを行うことが適切な場合があります。
Before doing so, it's important to understand what they are good for, and what's better left to other mechanisms.
これを行う前に、それらが何に適しているか、他のメカニズムに何を残すべきかを理解することが重要です。
Problem details are not a debugging tool for the underlying implementation; rather, they are a way to expose greater detail about the HTTP interface itself. Designers of new problem types need to carefully consider the Security Considerations (Section 5), in particular, the risk of exposing attack vectors by exposing implementation internals through error messages.
問題の詳細は、基礎となる実装のデバッグツールではありません。むしろ、それらはHTTPインターフェース自体の詳細を公開する方法です。新しい問題タイプの設計者は、セキュリティに関する考慮事項（セクション5）、特に、エラーメッセージを通じて実装の内部を公開することにより攻撃ベクトルを公開するリスクを慎重に検討する必要があります。
Likewise, truly generic problems -- i.e., conditions that could potentially apply to any resource on the Web -- are usually better expressed as plain status codes. For example, a "write access disallowed" problem is probably unnecessary, since a 403 Forbidden status code in response to a PUT request is self-explanatory.
同様に、真に一般的な問題-つまり、Web上の任意のリソースに潜在的に適用される可能性のある状態-は、通常、単純なステータスコードとして表現されます。たとえば、PUTリクエストに対する403 Forbiddenステータスコードは説明不要であるため、「書き込みアクセスが許可されていません」という問題はおそらく不要です。
Finally, an application might have a more appropriate way to carry an error in a format that it already defines. Problem details are intended to avoid the necessity of establishing new "fault" or "error" document formats, not to replace existing domain-specific formats.
最後に、アプリケーションには、すでに定義されている形式でエラーを運ぶためのより適切な方法がある場合があります。問題の詳細は、既存のドメイン固有の形式を置き換えるのではなく、新しい「障害」または「エラー」のドキュメント形式を確立する必要性を回避することを目的としています。
That said, it is possible to add support for problem details to existing HTTP APIs using HTTP content negotiation (e.g., using the Accept request header to indicate a preference for this format; see [RFC7231], Section 5.3.2).
とはいえ、HTTPコンテンツネゴシエーションを使用して既存のHTTP APIに問題の詳細のサポートを追加することは可能です（たとえば、Acceptリクエストヘッダーを使用してこの形式の設定を示します。[RFC7231]のセクション5.3.2を参照してください）。
New problem type definitions MUST document:
新しい問題タイプの定義は文書化する必要があります：
1. a type URI (typically, with the "http" or "https" scheme),
1. タイプURI（通常、「http」または「https」スキームを使用）、
2. a title that appropriately describes it (think short), and
2. それを適切に説明するタイトル（短く考える）、および
3. the HTTP status code for it to be used with.
3. 使用するHTTPステータスコード。
Problem type definitions MAY specify the use of the Retry-After response header ([RFC7231], Section 7.1.3) in appropriate circumstances.
問題タイプの定義では、適切な状況でRetry-After応答ヘッダー（[RFC7231]、セクション7.1.3）の使用を指定できます（MAY）。
A problem's type URI SHOULD resolve to HTML [W3C.REC-html5-20141028] documentation that explains how to resolve the problem.
問題のタイプURIは、問題の解決方法を説明するHTML [W3C.REC-html5-20141028]ドキュメントに解決する必要があります（SHOULD）。
A problem type definition MAY specify additional members on the problem details object. For example, an extension might use typed links [RFC5988] to another resource that can be used by machines to resolve the problem.
問題タイプの定義では、問題の詳細オブジェクトに追加のメンバーを指定できます（MAY）。たとえば、拡張機能は、問題を解決するためにマシンが使用できる別のリソースへの型付きリンク[RFC5988]を使用する場合があります。
If such additional members are defined, their names SHOULD start with a letter (ALPHA, as per [RFC5234], Appendix B.1) and SHOULD consist of characters from ALPHA, DIGIT ([RFC5234], Appendix B.1), and "_" (so that it can be serialized in formats other than JSON), and they SHOULD be three characters or longer.
そのような追加のメンバーが定義されている場合、その名前は文字（ALPHA、[RFC5234]、付録B.1に従って）で始まり（SHOULD）、ALPHA、DIGIT（[RFC5234]、付録B.1）、および「 _ "（JSON以外の形式でシリアル化できるようにするため）および3文字以上である必要があります（SHOULD）。
For example, if you are publishing an HTTP API to your online shopping cart, you might need to indicate that the user is out of credit (our example from above), and therefore cannot make the purchase.
たとえば、HTTP APIをオンラインショッピングカートに公開している場合、ユーザーにクレジットがない（上記の例）ため、購入できないことを示す必要がある場合があります。
If you already have an application-specific format that can accommodate this information, it's probably best to do that. However, if you don't, you might consider using one of the problem details formats -- JSON if your API is JSON-based, or XML if it uses that format.
この情報に対応できるアプリケーション固有の形式が既にある場合は、それを行うのがおそらく最善です。ただし、そうでない場合は、問題の詳細形式の1つを使用することを検討してください。APIがJSONベースの場合はJSON、その形式を使用する場合はXMLです。
To do so, you might look for an already-defined type URI that suits your purposes. If one is available, you can reuse that URI.
そのためには、目的に合った定義済みのタイプURIを探すことができます。使用可能な場合は、そのURIを再利用できます。
If one isn't available, you could mint and document a new type URI (which ought to be under your control and stable over time), an appropriate title and the HTTP status code that it will be used with, along with what it means and how it should be handled.
利用できない場合は、新しいタイプのURI（管理下にあり、長期にわたって安定しているはずです）、適切なタイトル、およびそれが使用されるHTTPステータスコードと、それが何を意味するかを作成および文書化できます。そしてそれがどう扱われるべきか。
In summary: an instance URI will always identify a specific occurrence of a problem. On the other hand, type URIs can be reused if an appropriate description of a problem type is already available someplace else, or they can be created for new problem types.
要約すると、インスタンスURIは常に問題の特定の発生を識別します。一方、問題のタイプの適切な説明がすでにどこかで利用できる場合はタイプURIを再利用できます。または、新しい問題タイプ用に作成することもできます。
This specification reserves the use of one URI as a problem type:
この仕様では、問題タイプとして1つのURIの使用を予約しています。
The "about:blank" URI [RFC6694], when used as a problem type, indicates that the problem has no additional semantics beyond that of the HTTP status code.
「about：blank」URI [RFC6694]を問題タイプとして使用すると、問題にはHTTPステータスコード以外のセマンティクスがないことが示されます。
When "about:blank" is used, the title SHOULD be the same as the recommended HTTP status phrase for that code (e.g., "Not Found" for 404, and so on), although it MAY be localized to suit client preferences (expressed with the Accept-Language request header).
「about：blank」を使用する場合、タイトルはそのコードに推奨されるHTTPステータスフレーズと同じである必要があります（たとえば、404の「Not Found」など）。 Accept-Languageリクエストヘッダーを使用）。
Please note that according to how the "type" member is defined (Section 3.1), the "about:blank" URI is the default value for that member. Consequently, any problem details object not carrying an explicit "type" member implicitly uses this URI.
「type」メンバーの定義方法（セクション3.1）に応じて、「about：blank」URIがそのメンバーのデフォルト値であることに注意してください。したがって、明示的な「タイプ」メンバーを持たない問題の詳細オブジェクトは、このURIを暗黙的に使用します。
When defining a new problem type, the information included must be carefully vetted. Likewise, when actually generating a problem -- however it is serialized -- the details given must also be scrutinized.
新しい問題タイプを定義する場合、含まれる情報は慎重に吟味する必要があります。同様に、実際に問題を生成する場合（ただし、シリアル化されていますが）、指定された詳細も精査する必要があります。
Risks include leaking information that can be exploited to compromise the system, access to the system, or the privacy of users of the system.
リスクには、システムの侵害、システムへのアクセス、またはシステムのユーザーのプライバシーの侵害に利用される可能性のある情報の漏洩が含まれます。
Generators providing links to occurrence information are encouraged to avoid making implementation details such as a stack dump available through the HTTP interface, since this can expose sensitive details of the server implementation, its data, and so on.
発生情報へのリンクを提供するジェネレーターは、HTTPインターフェースを通じてスタックダンプなどの実装の詳細を作成しないようにすることをお勧めします。これにより、サーバーの実装やそのデータなどの機密情報が公開される可能性があるためです。
The "status" member duplicates the information available in the HTTP status code itself, thereby bringing the possibility of disagreement between the two. Their relative precedence is not clear, since a disagreement might indicate that (for example) an intermediary has modified the HTTP status code in transit (e.g., by a proxy or cache).
「ステータス」メンバーは、HTTPステータスコード自体で利用可能な情報を複製するため、2つの間で不一致が生じる可能性があります。不一致は（たとえば）仲介者が転送中のHTTPステータスコードを（プロキシやキャッシュなどによって）変更したことを示している可能性があるため、それらの相対的な優先順位は明確ではありません。
As such, those defining problem types as well as generators and consumers of problems need to be aware that generic software (such as proxies, load balancers, firewalls, and virus scanners) are unlikely to know of or respect the status code conveyed in this member.
そのため、問題のタイプを定義する人、問題のジェネレータとコンシューマは、一般的なソフトウェア（プロキシ、ロードバランサ、ファイアウォール、ウイルススキャナなど）がこのメンバーで伝えられるステータスコードを認識または尊重する可能性が低いことを認識する必要があります。
This specification defines two new Internet media types [RFC6838].
この仕様は、2つの新しいインターネットメディアタイプ[RFC6838]を定義しています。
Type name: application
タイプ名：アプリケーション
Subtype name: problem+json
サブタイプ名：problem + json
Required parameters: None
必須パラメーター：なし
Optional parameters: None; unrecognized parameters should be ignored
オプションのパラメーター：なし。認識されないパラメータは無視する必要があります
Encoding considerations: Same as [RFC7159]
エンコードに関する考慮事項：[RFC7159]と同じ
Security considerations: see Section 5 of this document
セキュリティに関する考慮事項：このドキュメントのセクション5を参照してください
Interoperability considerations: None
相互運用性に関する考慮事項：なし
Published specification: RFC 7807 (this document)
公開された仕様：RFC 7807（このドキュメント）
Applications that use this media type: HTTP
このメディアタイプを使用するアプリケーション：HTTP
Fragment identifier considerations: Same as for application/json ([RFC7159])
フラグメント識別子の考慮事項：application / json（[RFC7159]）と同じ
Additional information:
追加情報：
Deprecated alias names for this type: n/a
このタイプの非推奨のエイリアス名：n / a
Magic number(s): n/a
File extension(s): n/a
Macintosh file type code(s): n/a
Person and email address to contact for further information:
Mark Nottingham <mnot@mnot.net>
Intended usage: COMMON
使用目的：COMMON
Restrictions on usage: None.
使用制限：なし。
Author: Mark Nottingham <mnot@mnot.net>
Change controller: IESG
コントローラーの変更：IESG
Type name: application
タイプ名：アプリケーション
Subtype name: problem+xml
サブタイプ名：problem + xml
Required parameters: None
必須パラメーター：なし
Optional parameters: None; unrecognized parameters should be ignored
オプションのパラメーター：なし。認識されないパラメータは無視する必要があります
Encoding considerations: Same as [RFC7303]
エンコードに関する考慮事項：[RFC7303]と同じ
Security considerations: see Section 5 of this document
セキュリティに関する考慮事項：このドキュメントのセクション5を参照してください
Interoperability considerations: None
相互運用性に関する考慮事項：なし
Published specification: RFC 7807 (this document)
公開された仕様：RFC 7807（このドキュメント）
Applications that use this media type: HTTP
このメディアタイプを使用するアプリケーション：HTTP
Fragment identifier considerations: Same as for application/xml (as specified by Section 5 of [RFC7303])
フラグメント識別子の考慮事項：application / xmlと同じ（[RFC7303]のセクション5で指定）
Additional information:
追加情報：
Deprecated alias names for this type: n/a
このタイプの非推奨のエイリアス名：n / a
Magic number(s): n/a
File extension(s): n/a
Macintosh file type code(s): n/a
Person and email address to contact for further information:
Mark Nottingham <mnot@mnot.net>
Intended usage: COMMON
使用目的：COMMON
Restrictions on usage: None.
使用制限：なし。
Author: Mark Nottingham <mnot@mnot.net>
Change controller: IESG
コントローラーの変更：IESG
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <http://www.rfc-editor.org/info/rfc2119>.
[RFC2119] Bradner、S。、「要件レベルを示すためにRFCで使用するキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<http://www.rfc-editor.org/info/ rfc2119>。
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, <http://www.rfc-editor.org/info/rfc3986>.
[RFC3986] Berners-Lee、T.、Fielding、R。、およびL. Masinter、「Uniform Resource Identifier（URI）：Generic Syntax」、STD 66、RFC 3986、DOI 10.17487 / RFC3986、2005年1月、<http：/ /www.rfc-editor.org/info/rfc3986>。
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008, <http://www.rfc-editor.org/info/rfc5234>.
[RFC5234]クロッカー、D。、エド。およびP. Overell、「構文仕様の拡張BNF：ABNF」、STD 68、RFC 5234、DOI 10.17487 / RFC5234、2008年1月、<http://www.rfc-editor.org/info/rfc5234>。
[RFC7159] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", RFC 7159, DOI 10.17487/RFC7159, March 2014, <http://www.rfc-editor.org/info/rfc7159>.
[RFC7159]ブレイ、T。、編、「JavaScriptオブジェクト表記（JSON）データ交換フォーマット」、RFC 7159、DOI 10.17487 / RFC7159、2014年3月、<http://www.rfc-editor.org/info/ rfc7159>。
[RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing", RFC 7230, DOI 10.17487/RFC7230, June 2014, <http://www.rfc-editor.org/info/rfc7230>.
[RFC7230]フィールディング、R。、エド。およびJ. Reschke編、「Hypertext Transfer Protocol（HTTP / 1.1）：Message Syntax and Routing」、RFC 7230、DOI 10.17487 / RFC7230、2014年6月、<http://www.rfc-editor.org/info/ rfc7230>。
[RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content", RFC 7231, DOI 10.17487/RFC7231, June 2014, <http://www.rfc-editor.org/info/rfc7231>.
[RFC7231]フィールディング、R。、エド。およびJ. Reschke編、「Hypertext Transfer Protocol（HTTP / 1.1）：Semantics and Content」、RFC 7231、DOI 10.17487 / RFC7231、2014年6月、<http://www.rfc-editor.org/info/rfc7231 >。
[W3C.REC-xml-20081126] Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", W3C Recommendation REC-xml-20081126, November 2008, <http://www.w3.org/TR/2008/REC-xml-20081126>.
[W3C.REC-xml-20081126]ブレイ、T。、パオリ、J.、Sperberg-McQueen、M。、マラー、E。、およびF.イェルガウ、「Extensible Markup Language（XML）1.0（Fifth Edition）」、 W3C勧告REC-xml-20081126、2008年11月、<http://www.w3.org/TR/2008/REC-xml-20081126>。
[ISO-19757-2]
International Organization for Standardization,
"Information Technology --- Document Schema Definition
Languages (DSDL) --- Part 2: Grammar-based Validation ---
RELAX NG", ISO/IEC 19757-2, 2003.
[RFC4918] Dusseault, L., Ed., "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)", RFC 4918, DOI 10.17487/RFC4918, June 2007, <http://www.rfc-editor.org/info/rfc4918>.
[RFC4918] Dusseault、L.、Ed。、「Web Distributed Authoring and Versioning（WebDAV）のHTTP拡張機能」、RFC 4918、DOI 10.17487 / RFC4918、2007年6月、<http://www.rfc-editor.org/info / rfc4918>。
[RFC5988] Nottingham, M., "Web Linking", RFC 5988, DOI 10.17487/RFC5988, October 2010, <http://www.rfc-editor.org/info/rfc5988>.
[RFC5988]ノッティンガム、M。、「Webリンク」、RFC 5988、DOI 10.17487 / RFC5988、2010年10月、<http://www.rfc-editor.org/info/rfc5988>。
[RFC6694] Moonesamy, S., Ed., "The "about" URI Scheme", RFC 6694, DOI 10.17487/RFC6694, August 2012, <http://www.rfc-editor.org/info/rfc6694>.
[RFC6694] Moonesamy、S.、Ed。、 "The" about "URI Scheme"、RFC 6694、DOI 10.17487 / RFC6694、August 2012、<http://www.rfc-editor.org/info/rfc6694>
[RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type Specifications and Registration Procedures", BCP 13, RFC 6838, DOI 10.17487/RFC6838, January 2013, <http://www.rfc-editor.org/info/rfc6838>.
[RFC6838] Freed、N.、Klensin、J。、およびT. Hansen、「Media Type Specifications and Registration Procedures」、BCP 13、RFC 6838、DOI 10.17487 / RFC6838、2013年1月、<http：//www.rfc- editor.org/info/rfc6838>。
[RFC7303] Thompson, H. and C. Lilley, "XML Media Types", RFC 7303, DOI 10.17487/RFC7303, July 2014, <http://www.rfc-editor.org/info/rfc7303>.
[RFC7303] Thompson、H。およびC. Lilley、「XML Media Types」、RFC 7303、DOI 10.17487 / RFC7303、2014年7月、<http://www.rfc-editor.org/info/rfc7303>。
[W3C.REC-html5-20141028] Hickson, I., Berjon, R., Faulkner, S., Leithead, T., Navara, E., O'Connor, E., and S. Pfeiffer, "HTML5", W3C Recommendation REC-html5-20141028, October 2014, <http://www.w3.org/TR/2014/REC-html5-20141028>.
[W3C.REC-html5-20141028] Hickson、I.、Berjon、R.、Faulkner、S.、Width、T.、Navara、E.、O'Connor、E.、and S. Pfeiffer、 "HTML5"、 W3C勧告REC-html5-20141028、2014年10月、<http://www.w3.org/TR/2014/REC-html5-20141028>。
[W3C.REC-rdfa-core-20130822] Adida, B., Birbeck, M., McCarron, S., and I. Herman, "RDFa Core 1.1 - Second Edition", W3C Recommendation REC-rdfa-core-20130822, August 2013, <http://www.w3.org/TR/2013/REC-rdfa-core-20130822>.
[W3C.REC-rdfa-core-20130822] Adida、B.、Birbeck、M.、McCarron、S.、and I. Herman、 "RDFa Core 1.1-Second Edition"、W3C Recommendation REC-rdfa-core-20130822、 2013年8月、<http://www.w3.org/TR/2013/REC-rdfa-core-20130822>。
[W3C.REC-xml-stylesheet-20101028] Clark, J., Pieters, S., and H. Thompson, "Associating Style Sheets with XML documents 1.0 (Second Edition)", W3C Recommendation REC-xml-stylesheet-20101028, October 2010, <http://www.w3.org/TR/2010/REC-xml-stylesheet-20101028>.
[W3C.REC-xml-stylesheet-20101028]クラークJ.、ピーターズS.、およびH.トンプソン、「スタイルシートとXMLドキュメント1.0の関連付け（第2版）」、W3C勧告REC-xml-stylesheet-20101028、 2010年10月、<http://www.w3.org/TR/2010/REC-xml-stylesheet-20101028>。
Some HTTP-based APIs use XML [W3C.REC-xml-20081126] as their primary format convention. Such APIs can express problem details using the format defined in this appendix.
一部のHTTPベースのAPIは、主要な形式規則としてXML [W3C.REC-xml-20081126]を使用します。このようなAPIは、この付録で定義されている形式を使用して問題の詳細を表現できます。
The RELAX NG schema [ISO-19757-2] for the XML format is as follows. Keep in mind that this schema is only meant as documentation, and not as a normative schema that captures all constraints of the XML format. Also, it would be possible to use other XML schema languages to define a similar set of constraints (depending on the features of the chosen schema language).
XML形式のRELAX NGスキーマ[ISO-19757-2]は次のとおりです。このスキーマはドキュメントとしてのみ意図されており、XML形式のすべての制約を取り込む規範的なスキーマとしてではないことに注意してください。また、他のXMLスキーマ言語を使用して、同様の一連の制約を定義することもできます（選択したスキーマ言語の機能によって異なります）。
default namespace ns = "urn:ietf:rfc:7807"
start = problem
開始=問題
problem =
element problem {
( element type { xsd:anyURI }?
& element title { xsd:string }?
& element detail { xsd:string }?
& element status { xsd:positiveInteger }?
& element instance { xsd:anyURI }? ),
anyNsElement
}
anyNsElement =
( element ns:* { anyNsElement | text }
| attribute * { text })*
The media type for this format is "application/problem+xml".
この形式のメディアタイプは「application / problem + xml」です。
Extension arrays and objects are serialized into the XML format by considering an element containing a child or children to represent an object, except for elements that contain only child element(s) named 'i', which are considered arrays. For example, the example above appears in XML as follows: HTTP/1.1 403 Forbidden Content-Type: application/problem+xml Content-Language: en
配列と見なされる「i」という名前の子要素のみを含む要素を除いて、オブジェクトを表すために子を含む要素を考慮することにより、拡張配列とオブジェクトはXML形式にシリアル化されます。たとえば、上記の例はXMLで次のように表示されます。HTTP / 1.1 403 Forbidden Content-Type：application / problem + xml Content-Language：en
<?xml version="1.0" encoding="UTF-8"?>
<problem xmlns="urn:ietf:rfc:7807">
<type>https://example.com/probs/out-of-credit</type>
<title>You do not have enough credit.</title>
<detail>Your current balance is 30, but that costs 50.</detail>
<instance>https://example.net/account/12345/msgs/abc</instance>
<balance>30</balance>
<accounts>
<i>https://example.net/account/12345</i>
<i>https://example.net/account/67890</i>
</accounts>
</problem>
Note that this format uses an XML namespace. This is primarily to allow embedding it into other XML-based formats; it does not imply that it can or should be extended with elements or attributes in other namespaces. The RELAX NG schema explicitly only allows elements from the one namespace used in the XML format. Any extension arrays and objects MUST be serialized into XML markup using only that namespace.
この形式はXML名前空間を使用することに注意してください。これは主に、それを他のXMLベースのフォーマットに埋め込むことができるようにするためです。他の名前空間の要素や属性で拡張できること、または拡張する必要があることを意味するものではありません。 RELAX NGスキーマは、XML形式で使用される1つの名前空間の要素のみを明示的に許可します。拡張配列とオブジェクトは、その名前空間のみを使用してXMLマークアップにシリアル化する必要があります。
When using the XML format, it is possible to embed an XML processing instruction in the XML that instructs clients to transform the XML, using the referenced XSLT code [W3C.REC-xml-stylesheet-20101028]. If this code is transforming the XML into (X)HTML, then it is possible to serve the XML format, and yet have clients capable of performing the transformation display human-friendly (X)HTML that is rendered and displayed at the client. Note that when using this method, it is advisable to use XSLT 1.0 in order to maximize the number of clients capable of executing the XSLT code.
XML形式を使用する場合、参照されているXSLTコード[W3C.REC-xml-stylesheet-20101028]を使用して、クライアントにXMLの変換を指示するXML処理命令をXMLに埋め込むことができます。このコードがXMLを（X）HTMLに変換する場合、XML形式を提供することは可能ですが、クライアントでレンダリングおよび表示される変換表示を実行できる（X）HTMLの変換を実行できるクライアントがあります。この方法を使用する場合は、XSLTコードを実行できるクライアントの数を最大化するために、XSLT 1.0を使用することをお勧めします。
In some situations, it can be advantageous to embed problem details in formats other than those described here. For example, an API that uses HTML [W3C.REC-html5-20141028] might want to also use HTML for expressing its problem details.
状況によっては、ここで説明する形式以外の形式で問題の詳細を埋め込むことが有利な場合があります。たとえば、HTML [W3C.REC-html5-20141028]を使用するAPIでは、問題の詳細を表現するためにHTMLも使用したい場合があります。
Problem details can be embedded in other formats either by encapsulating one of the existing serializations (JSON or XML) into that format or by translating the model of a problem detail (as specified in Section 3) into the format's conventions.
問題の詳細は、既存のシリアル化（JSONまたはXML）の1つをその形式にカプセル化するか、問題の詳細のモデル（セクション3で指定）を形式の規則に変換することにより、他の形式に埋め込むことができます。
For example, in HTML, a problem could be embedded by encapsulating JSON in a script tag:
たとえば、HTMLでは、JSONをスクリプトタグにカプセル化することで問題を埋め込むことができます。
<script type="application/problem+json">
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit.",
"detail": "Your current balance is 30, but that costs 50.",
"instance": "/account/12345/msgs/abc",
"balance": 30,
"accounts": ["/account/12345",
"/account/67890"]
}
</script>
or by inventing a mapping into RDFa [W3C.REC-rdfa-core-20130822].
または、RDFaへのマッピングを発明することによって[W3C.REC-rdfa-core-20130822]。
This specification does not make specific recommendations regarding embedding problem details in other formats; the appropriate way to embed them depends both upon the format in use and application of that format.
この仕様では、問題の詳細を他の形式に埋め込むことに関する特定の推奨事項はありません。それらを埋め込む適切な方法は、使用中のフォーマットとそのフォーマットのアプリケーションの両方に依存します。
Acknowledgements
謝辞
The authors would like to thank Jan Algermissen, Subbu Allamaraju, Mike Amundsen, Roy Fielding, Eran Hammer, Sam Johnston, Mike McCall, Julian Reschke, and James Snell for review of this specification.
この仕様のレビューについて、Jan Algermissen、Subbu Allamaraju、Mike Amundsen、Roy Fielding、Eran Hammer、Sam Johnston、Mike McCall、Julian Reschke、James Snellに感謝します。
Authors' Addresses
著者のアドレス
Mark Nottingham Akamai
マークノッティンガムアカマイ
Email: mnot@mnot.net
URI: https://www.mnot.net/
Erik Wilde
エリック・ワイルド
Email: erik.wilde@dret.net
URI: http://dret.net/netdret/