Axe DevTools Linter REST API 使用例

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Free Trial
Not for use with personal data

この記事では、Axe DevTools Linter を curl と Python を使用してアクセスするためのコード例を示します。

curl

次の例は、 curl コマンドラインツールを使用してサーバーに POST リクエストを送信する方法を示しています。

curl --request POST \
  --url http://localhost:3000/lint-source \
  --header 'Content-Type: application/json' \
  --data '{
        "source":"import React from \"react\";const testing = (props) => {    return (        <div>            <button tabIndex={5}>{props.name}</button>            <button tabIndex={5}>{props.name}</button>            <button tabIndex=\"5\">{props.name}</button>        </div>    );}\nexport default testing;",
        "filename": "string.js"
}'

上記のサンプルを Axe DevTools Linter SaaS で使用するには、次のコマンドラインオプションを追加する必要があります。

--header 'Authorization: <YOUR API KEY>' \

また、 --url コマンドラインオプションを以下のように変更する必要があります。

--url https://axe-linter.deque.com/lint-source

Axe DevTools Linter SaaS 用に更新したサンプルは以下の通りです。

curl --request POST \
  --url https://axe-linter.deque.com/lint-source \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <YOUR API KEY>' \
  --data '{
        "source":"import React from \"react\";const testing = (props) => {    return (        <div>            <button tabIndex={5}>{props.name}</button>            <button tabIndex={5}>{props.name}</button>            <button tabIndex=\"5\">{props.name}</button>        </div>    );}\nexport default testing;",
        "filename": "string.js"
}'

Axe DevTools Linter SaaS の API キーを取得する方法については、 Axe DevTools Linter SaaS API キーの取得 を参照してください。

Python

次の例は、Python 3 を使用して Axe DevTools Linter にアクセスする方法を示しています。

import requests

baseUrl = "http://localhost:3000/lint-source"

headers = {
      "Content-Type": "application/json"
      }

data = {
  "source": "# Heading\n\n### Another Heading\n",
  "filename": "file.md"
     }

response = requests.post(baseUrl, json=data, headers=headers)

print(response.text)

以前の Python サンプルを Axe DevTools Linter SaaS で動作させるには、 Axe DevTools Linter SaaS API キーの取得 に詳細された通りに API キーを取得し、 baseUrl を以下のように変更する必要があります。

baseUrl = "https://axe-linter.deque.com/lint-source"

さらに、リクエストヘッダーに API キーを追加するには、 headers を以下のように変更する必要があります。

headers = {
      "Content-Type": "application/json",
      "Authorization": "YOUR API KEY"
      }

先ほど取得したキーで YOUR API KEY を置き換えてください。