Documentação da API
Esta API retorna uma lista de artigos/categorias no formato JSON.
Endpoints
Método | Endpoint | Parâmetros | Descrição |
---|---|---|---|
/api/v1/artigos/ | limit (opcional), page (opcional), search (opcional), catid (opcional), id (opcional) | Retorna uma lista dos artigos. | |
/api/v1/categorias/ | limit (opcional), id (opcional) | Retorna uma lista de categorias |
Exemplos
Retornar 99 primeiros artigos por padrão (utilizar em conjunto com o parâmetro page para paginação dos resultados):
/api/v1/artigos/
Retornar apenas um artigo pelo ID:
/api/v1/artigos/?id=1
Retornar resultados de uma busca pelo alias ou title, caso exista correspondencia:
/api/v1/artigos/?search=apelido-ou-titulo-para-busca
Retornar apenas os artigos de uma determinada categoria:
/api/v1/artigos/?catid=2
Retornar apenas os 3 artigos mais recentes:
/api/v1/artigos/?limit=3
Retornar apenas os 3 artigos mais recentes:
/api/v1/artigos/?limit=3
Paginação de resultados (utilizar em conjunto com o parâmetro limit para o limite de resultados por requisição):
/api/v1/artigos/?page=2
Retornar apenas a categoria com determinado id:
/api/v1/categorias/?id=2
Retornar apenas os 3 categorias mais recentes:
/api/v1/categorias/?limit=3