API de Assuntos¶

Queries¶

assuntos

Query de Lista de Assuntos de acordo com os filtros abaixo

Tipo de Retorno

Autorização Necessária Ler Mais

Nenhuma

Argumentos

Nome	Tipo	Descrição
materia	[String]	Filtrar Assuntos por nome de Matérias (Nome exato)
nome	String	Filtrar Assuntos por nome (Regex, case-insensitive)
anos	[Int]	Filtrar Assuntos por anos
vestibulares	[String]	Filtrar Assuntos por Vestibular(es) (Nomes exato)
fontes	[FonteOptions]	Filtrar Assuntos por Fonte(s)

Exemplo de Query

query {
  assuntos(
    materia: ["Português", "Matemática"]
    anos: [2010, 2011]
    vestibulares: ["ENEM", "ITA"]
    fontes: [VESTIBULARES_ANTERIORES]
  ) {
    materia
    assuntos {
      nome
      _id
    }
  }
}

Exemplo de Resposta

{
  "data": {
    "assuntos": [
      {
        "materia": "Matemática",
        "assuntos": [
          {
            "nome": "Matrizes",
            "_id": "5d25f685c991defc373e29db"
          },
          {
            "nome": "Geometria",
            "_id": "5d25f685c991defc373e2915"
          },
          {
            "nome": "Matrizes-autovalores",
            "_id": "5d25f685c991defc373e29dc"
          }
        ]
      }
    ]
  }
}

assunto

Query de um Assunto específico, por ID

Tipo de Retorno

Assunto

Autorização Necessária Ler Mais

Nenhuma

Argumentos

Nome	Tipo	Padrão	Descrição
_id	ID!		ID do Assunto no Banco

Exemplo de Query

query {
  assunto(_id: "5d25f685c991defc373e2729") {
    _id
    nome
    materia
  }
}

Exemplo de Resposta

{
  "data": {
    "assunto": {
      "_id": "5d25f685c991defc373e2729",
      "nome": "Analítica",
      "materia": "Matemática"
    }
  }
}

Mutations¶

createAssunto

Criar um Novo Assunto

Tipo de Retorno

Assunto

Autorização Necessária Ler Mais

'admin' | 'apiUser'

Argumentos

Nome	Tipo	Padrão	Descrição
nome	String!		Nome do Assunto
materia	String!		Nome da Matéria do Assunto

Exemplo de Mutation

mutation {
  createAssunto(nome: "Assunto Teste", materia: "Português") {
    _id
    nome
    materia
  }
}

Exemplo de Resposta

{
  "data": {
    "createAssunto": {
      "_id": "5d25f685c991defc373e2729",
      "nome": "Assunto Teste",
      "materia": "Português"
    }
  }
}

updateAssunto

Atualizar um Assunto existente

Tipo de Retorno

Assunto

Autorização Necessária Ler Mais

'admin' | 'apiUser'

Argumentos

Nome	Tipo	Padrão	Descrição
_id	ID!		ID do Assunto a ser atualizado no Banco
assunto	InputAssunto		Campos do assunto a serem alterados

Exemplo de Mutation

mutation ($_id: ID!, $assunto: InputAssunto!) {
  updateAssunto(_id: $_id, assunto: $assunto) {
    _id
    nome
    materia
  }
}

Varíaveis

{
  "_id": "5d25f685c991defc373e2729",
  "assunto": {
    "nome": "Nome de Assunto Atualizado",
    "materia": "Português"
  }
}

Exemplo de Retorno

{
  "data": {
    "updateAssunto": {
      "_id": "5d25f685c991defc373e2729",
      "nome": "Nome de Assunto Atualizado",
      "materia": "Português"
    }
  }
}