Axe DevTools Linter REST API – Beispielverwendung

Link to Axe DevTools Linter REST API – Beispielverwendung copied to clipboard
Free Trial
Not for use with personal data

Dieser Artikel zeigt Beispielcode für den Zugriff auf axe DevTools Linter mit curl und Python.

curl

Das folgende Beispiel zeigt, wie Sie mit dem Befehlszeilentool curl POST-Anfragen an den Server senden:

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"
}'

Um das obige Beispiel mit axe DevTools Linter SaaS zu verwenden, müssen Sie die folgende Befehlszeilenoption hinzufügen:

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

Sie müssen außerdem die Befehlszeilenoption --url wie folgt ändern:

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

Das für axe DevTools Linter SaaS aktualisierte Beispiel lautet wie folgt:

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"
}'

Weitere Informationen zum Abrufen eines API-Schlüssels zur Verwendung mit axe DevTools Linter SaaS finden Sie unter Abrufen eines axe DevTools Linter SaaS-API-Schlüssels .

Python

Das folgende Beispiel zeigt, wie Sie mit Python 3 auf den axe DevTools Linter zugreifen:

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)

Um das vorherige Python-Beispiel so zu ändern, dass es mit axe DevTools Linter SaaS funktioniert, müssen Sie einen API-Schlüssel wie unter Erhalten eines axe DevTools Linter SaaS-API-Schlüssels beschrieben abrufen und baseUrl wie folgt ändern:

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

Sie müssen Ihren API-Schlüssel auch zum Anforderungsheader hinzufügen, indem Sie die Header wie folgt ändern:

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

Ersetzen Sie ihren API-Schlüssel durch den Schlüssel, den Sie zuvor erhalten haben.