Ejemplo de uso de la API REST de axe DevTools Linter

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

Este artículo muestra un código de ejemplo para acceder a axe DevTools Linter con curl y Python.

curl

El siguiente ejemplo muestra cómo utilizar la herramienta de línea de comandos curl para enviar solicitudes POST al servidor:

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

Para utilizar el ejemplo anterior con axe DevTools Linter SaaS, debe agregar la siguiente opción de línea de comando:

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

También debe cambiar la opción de línea de comandos --url a:

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

La muestra actualizada para axe DevTools Linter SaaS es la siguiente:

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

Consulte Cómo obtener una clave API de axe DevTools Linter SaaS para obtener más información sobre cómo obtener una clave API para usar con axe DevTools Linter SaaS.

Python

El siguiente ejemplo muestra cómo acceder a axe DevTools Linter usando Python 3:

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)

Para cambiar el ejemplo de Python anterior para que funcione con axe DevTools Linter SaaS, debe obtener una clave API como se detalla en Obtención de una clave API de axe DevTools Linter SaaS y cambiar baseUrl de la siguiente manera:

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

También debe agregar su clave API al encabezado de la solicitud cambiando headers por lo siguiente:

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

Reemplace SU CLAVE API con la clave que obtuvo anteriormente.