Compartir a través de


Editor de la API de Fabric para GraphQL

La API de Fabric para GraphQL proporciona un entorno de desarrollo gráfico de GraphQL en el explorador, que permite que un área de juegos interactiva cree, pruebe y vea los resultados en directo de las consultas y mutaciones de GraphQL.

Para ir al editor, abra el elemento API for GraphQL desde su área de trabajo en Tejido y seleccione Consulta en la esquina inferior izquierda de la pantalla del portal.

Captura de pantalla que muestra dónde aparece la opción Consulta en la esquina inferior izquierda de la pantalla Tejido.

Escriba y ejecute consultas de GraphQL directamente en la pestaña Consulta . Las funcionalidades de IntelliSense están disponibles con un método abreviado de teclado: CTRL + Espacio (Windows) o Comando + Espacio (macOS). Seleccione Ejecutar para ejecutar la consulta y recuperar datos del origen de datos.

Captura de pantalla de la pantalla del editor de API, que muestra una pestaña Consulta dividida en paneles Ejecutar, Variables de consulta y Resultados.

Generación de código

Después de probar y crear prototipos de la operación de GraphQL deseada, el editor de API genera python reutilizable o Node.js código basado en la consulta o mutación ejecutada en el editor. Puede ejecutar el código generado localmente con fines de prueba y reutilizar partes de él en el proceso de desarrollo de aplicaciones.

Importante

El código generado usa credenciales interactivas del explorador y solo debe usarse con fines de prueba. En producción, registre siempre una aplicación en Microsoft Entra y use los ámbitos y client_id adecuados. Puede encontrar un ejemplo completo con código de ejemplo en Conectar aplicaciones.

Para empezar, ejecute una consulta, seleccione el botón Generar código y elija el idioma en consecuencia:

Captura de pantalla del editor de API que muestra cómo generar la opción de código.

A continuación, puede copiar el código generado y guardarlo como un archivo en una carpeta local. En función del idioma elegido, siga estos sencillos pasos para probar localmente:

Python

  1. Cree un entorno virtual mediante la ejecución del comando python -m venv .venv.

  2. Active mediante venv la ejecución .venv\Scripts\activate de o source .venv/bin/activate.

  3. Instale la dependencia necesaria mediante la ejecución pip install azure.identityde .

  4. Ejecute el código con python <filename.py>.

Node.JS

  1. En la misma carpeta que el archivo que guardó, cree un archivo package.json con el siguiente contenido:

    {
      "type": "module",
      "dependencies": {}
    }
    
  2. Ejecute npm install --save @azure/identity o un comando similar en el administrador de paquetes elegido para instalar la versión más reciente de la biblioteca de identidades.

  3. Ejecute el código con node <filename>.js.

Desarrollo de consultas y mutaciones

Revise este breve esquema de GraphQL. Define un único Post tipo con consultas para leer una sola publicación o enumerar todas las publicaciones y mutaciones para crear, actualizar o eliminar publicaciones, y admitir todos los casos de uso cruDL (crear, leer, actualizar, eliminar, enumerar).

{
  type Post {
    id: ID!
    published: Boolean
  }

  type Query {
    getPost(id: ID!): Post
    getAllPosts: [Post]
  }

  type Mutation {
    createPost(title: String!, content: String!, author: String!): Post
    updatePost(id: ID!, title: String, content: String, author: String, published: Boolean): Post
    deletePost(id: ID!): Boolean
  }
}

Lea los datos expuestos a través de GraphQL mediante cualquier consulta definida en el esquema. La getPost consulta tiene el aspecto de este ejemplo.

query MyQuery {
  getPost(id: "1234") {
    title
    content
    author
  }
}

Respuesta:

{
  "data": {
    "getPost": {
      "title": "First Post",
      "content": "This is my first post.",
      "author": "Jane Doe"
    }
  }
}

Use mutaciones como createPost para escribir datos y crear una publicación con los parámetros necesarios.

mutation MyMutation {
  createPost(title: "Second post", content: "This is my second post", author: "Jane Doe", published: false) {
    id
    title
    content
    author
  }
}

Respuesta:

{
  "data": {
    "createPost": {
      "id": "5678",
      "title": "Second Post",
      "content": "This is my second post.",
      "author": "Jane Doe"
    }
  }
}

Variables de consulta

Use el panel Variables de consulta en el lado derecho de la pestaña Consulta para pasar parámetros como variables a las consultas o mutaciones. Las variables funcionan como variables en otros lenguajes de programación. Cada variable se declara con un nombre que se usa para tener acceso al valor almacenado en ella. Con el ejemplo de mutación anterior, se modifica ligeramente para usar variables de consulta.

mutation MyMutation ($title: String!, $content: String!, $author: String!){
  createPost(title: $title, content: $content, author: $author) {
    id
    title
    content
    author
  }
}

Defina variables en el panel mediante el ejemplo siguiente.

{
  "id": "5678",
  "title": "Second Post",
  "content": "This is my second post.",
  "author": "Jane Doe"
}

Las variables hacen que el código de mutación sea más limpio, fácil de leer, probar y modificar.