API文書の照会
    • PDF

    API文書の照会

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    Stageに公開された API説明書を照会します。直接作成した APIでのみ使用できます。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/products/{product-id}/apis/{api-id}/documents

    リクエストヘッダ

    API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

    リクエストパスパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    product-idStringRequiredAPIが属する Product ID
    api-idStringRequired文書を照会する対象 APIの ID

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/w1k03m9zo9/apis/cvcohvd2xj/documents' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンス構文

    レスポンス構文は次の通りです。

    {
      "apiId" : "apiId",
      "documentMd" : "documentMd",
      "tenantId" : "tenantId",
      "modifier" : "modifier"  
    }
    

    レスポンスステータスコード

    API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "apiId": "cvcohvd2xj",
        "documentMd": "API文書の説明書",
        "tenantId": "********65ec41039ce6668c2058b8a9",
        "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.