RFC 9457: Problem Details for HTTP APIs
RFC 9457: Problem Details for HTTP APIs
前にこの RFC (読んだのは RFC 7807) を読んで "type" 項目が HTTP の URL になってるのにとても感銘をうけたので、どこかで使いたいと思っていた。
今日、ふと自社製品の設定ファイルの説明も頑張って設定ファイルに書くのではなく、ドキュメントの URL リンクにすればいいのではないかという気持ちになった。
間違いなく設定ファイルに説明を頑張って書くより、ドキュメント側を頑張った方がいい。
設定イメージ
## https://doc.example.com/conf#spam
# spam = egg
## https://doc.example.com/conf#beacon
# beacon = 10