Swaggerの応答とエラーコード

さまざまな回答の意味を学ぶ

対応への理解

HTTP応答には多くの種類があるため、ここではNMKR Studio APIに最も関連するものを取り上げます。

HTTP応答コードは3桁の数字で構成されます：

• 1桁目はカテゴリー

• 2桁目と3桁目はサブカテゴリーを定義する

2xx コード

2で始まるコードは、有効なAPI方法コールを送信し、正しく実行されたことを意味します。高度なレベルでは、「200」応答を確認することになります。これは直訳すると「OK」を意味し、メソッドが正しく実行されたことを意味します。

4xx コード

4で始まるコードは、無効なAPI方法コールを送信したことを意味し、NMKR Studioサーバーはこれを処理し、何が間違っていたかの情報を返します。NMKR Studioサーバーはこれを処理し、何が間違っているかの情報を返します。これをSwaggerドキュメントと比較して、エラーを修正することができます。一般的な応答は、API Keyに問題がある場合の「401」と、プロジェクト/NFTのUIDが見つからない場合の「404」です。

5xx コード

5で始まるコードは、サーバー側に問題があることを意味します。これらは2や4よりも稀で、方法コールの構築方法とは関係ないかもしれません。例えば「503」エラーは、万が一APIサービスが利用できない場合に表示されます。

すべての方法には、あらかじめ定義された可能性の高い応答のセットがあり、応答ペイロードが何を返すかという追加情報があることがわかります。