API:Query/pt

O módulo  permite-lhe obter a informação sobre uma wiki e os dados guardados na mesma, tal como o texto wiki de uma página em particular, as hiperligações e as categorias de um conjunto de páginas, ou o código (token) que precisa para.



Documentação da API


Módulos de consulta
O módulo de consulta tem três tipos de submódulos (também chamados módulos de consulta):


 * sobre a wiki e o usuário conectado.
 * de páginas, incluídas as revisões de página e o conteúdo.
 * de páginas que coincidem com certos critérios.

Exemplos


Exemplo 1: Especificar as páginas
A diferença dos módulos de consulta meta e lista, todos os módulos de consulta de propriedades funcionam num conjunto de páginas que se podem especificar de uma das seguintes maneiras:

A maioria dos módulos de consulta converterão a VÃO de revisão à VÃO de página correspondente. Only actually uses the revision ID itself.
 * By name using the  parameter, e.g..
 * By page ID using the  parameter, e.g..
 * By revision ID using the  parameter, e.g..
 * Utilizar um gerador.



Resposta


Exemplo 2: Normalização do título
Normalização de títulos converte títulos de páginas a sua forma canónica.

Isto significa pôr em maiúscula o primeiro carácter, substituir os guiões baixos com espaços e mudar o espaço de nomes à forma localizada definida para essa wiki.



Resposta


Exemplo 3: Títulos inválidos e em falta
Titles that don't exist or are invalid will have a  or   attribute set in the response.

Em formatos de saída que admitam chaves de matriz numéricas, os títulos faltantes e inválidos terão IDs de página negativas.

In some cases, a title can be viewed by a user but cannot be accessed by the API, such as pages that mirror content from another wiki. These titles will have a  attribute set in the response.



Resposta


Exemplo 4: Continuar consultas
When all the data is not returned in the response of a query, there will be a  attribute to indicate that there is more data.



Resposta
Para obter mais dados, agregue seus valores à solicitação original.

Response


Exemplo 5: Batchcomplete
The API returns a  element to indicate that all data for the current batch of items has been returned.

In the response of the sample query below,  has been included to indicate that all the data for each of the three images has been returned.

A próxima continuação começará devolver dado para o seguinte conjunto de 3 imagens.



Resposta


Exemplo 6: Geradores
Usa geradores se desejas obter dados sobre um conjunto de páginas

For example, to get data about pages in a certain category, instead of querying  and then querying again with   set to all the returned pages, combine the two API calls into one by using.

Quando utilizes um módulo de lista como um gerador, não precisas especificar as páginas.

No entanto, para um módulo de propriedades, deves specify the pages nas que trabalhará o gerador.

For example, to load all pages that are linked to from the main page, use.

Os parâmetros passados ​​a um erador devem ter o prefixo g. Por exemplo, quando uses generator=backlinks, usa  em lugar de bllimit.

A consulta de mostra abaixo, obtém enlaces e categorias para as primeiras três páginas no espaço de nomes principal que comecem com "Ba".



Continuing queries
Very often you will not get all the data you want in one API query. When that happens the API result indicates there is more data.

Because there are more data matching the query, the API result includes a  element. If you want further data, you would add its values (in the example,  and  ) to the original request to get the next set of results. You continue to do this until an API result does not have a  element, indicating there are no more data matching the query.

Here is Python code showing how to iterate over query results (using the python requests lib). Note you should not manipulate or depend on any specifics of the values returned inside the  element, as they may change.

batchcomplete
When you make an API request using a generator together with properties, the API result may signal to continue because there are more properties to retrieve for the pages so far, or because there are more pages from the generator, or both. From version 1.25 onwards, the API returns a  element to indicate that all data for the current "batch" of pages has been returned. This can be useful to avoid building a combined result set for thousands of pages when using a generator together with prop modules that may themselves need continuation.

Backwards compatibility of continue
From MediaWiki 1.21 to 1.25, it was required to specify  (i.e. with an empty string as the value) in the initial request to get continuation data in the format described above. Without doing that, API results would indicate there is additional data by returning a  element, explained in Raw query continue. Prior to 1.21, that raw continuation was the only option.

If your application needs to use the raw continuation in MediaWiki 1.26 or later, you must specify  to request it.



Avisos possíveis


Histórico de parâmetros

 * v1.21: Introduzido
 * v1.24: Introduzido  (note que a continuação raw era o comportamento predefinido até à v1.26)

<span id="Additional_notes">

Notas adicionais

 * Specifying titles through  or   is limited to 50 titles per query, or 500 for those with the   right.
 * Use multiple query modules together to get what you need in one request, e.g..
 * Generators always pass page titles to the query module. Unlike lists (which may include additional data by default), generators should not output any information themselves, unless when explicitly requested via the generator module's query parameters.

Resolving redirects
Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title. When present, they will always contain  and   attributes and may contain a   attribute for those redirects that point to specific sections.

Both normalization and redirection may take place. In the case of multiple redirects, all redirects will be resolved, and in case of a circular redirect, there might not be a page in the 'pages' section (see also below). Redirect resolution cannot be used in combination with the  parameter or with a generator generating revids; doing that will produce a warning and will not resolve redirects for the specified revids.

The examples below show how the  parameter works.

<span id="See_also">

Consulte também

 * - O guia de início rápido.
 * - Contém informação sobre como utilizar o parâmetro.