ibge.v1 #
Constants #
const names_providers = {
Providers.dados_abertos_br: 'dados-abertos-br'
Providers.gov: 'gov'
Providers.wikipedia: 'wikipedia'
}
const uri_municipios = 'https://brasilapi.com.br/api/ibge/municipios/v1'
Para referência: https://brasilapi.com.br/docs#tag/IBGE/paths/~1ibge~1municipios~1v1~1{siglaUF}?providers=dados-abertos-br,gov,wikipedia/get
const uri_uf = 'https://brasilapi.com.br/api/ibge/uf/v1'
Para referência https://brasilapi.com.br/docs#tag/IBGE/paths/~1ibge~1uf~1v1/get
fn get_estado_por_sigla_ou_codigo #
pub fn get_estado_por_sigla_ou_codigo(sigla_ou_codigo SiglaCodigo) !Estado
get_estado_por_sigla_ou_codigo Retorna informações de um estado do Brasil
https://brasilapi.com.br/docs#tag/IBGE/paths/~1ibge~1uf~1v1~1{siglaOuCodigo}/get
Exemplos de uso:
if estado := _ibge.get_estado_por_sigla_ou_codigo(sigla_ou_codigo: 'PB') { dump(estado) } else { dump(err) }Caso ocorro algum erro, o retorno será um IBGEError
fn get_estados #
pub fn get_estados() ![]Estado
get_estados Retorna informações de todos estados do Brasil
https://brasilapi.com.br/docs#tag/IBGE/paths/~1ibge~1uf~1v1/get
Exemplos de uso:
if estados := _ibge.get_estados() { dump(estados) } else { dump(err) }Caso ocorro algum erro, o retorno será um IBGEError
fn get_municipios #
pub fn get_municipios(param ParamsGet) ![]IBGE
get_municipios Retorna os municípios da unidade federativa
Exemplos de uso:
if municipios := ibfe.get_municipios(uf: 'PB', providers: ibge.Providers.dados_aberto_br | Wikipedia) { dump(municipios) } else { dump(err) }Caso ocorro algum erro, o retorno será um IBGEError
type SiglaCodigo #
pub type SiglaCodigo = int | string
fn (SiglaCodigo) str #
pub fn (s SiglaCodigo) str() string
enum Providers #
@[flag]
pub enum Providers {
dados_abertos_br
gov
wikipedia
}
fn (Providers) get_names_setad #
pub fn (p Providers) get_names_setad() []string
struct Estado #
pub struct Estado {
pub:
id int
sigla string
nome string
regiao ?Regiao
}
struct IBGE #
pub struct IBGE {
pub:
nome string
codigo_ibge string
}
struct ParamsGet #
@[params]
pub struct ParamsGet {
pub:
uf string @[required]
providers Providers @[required]
}
struct Regiao #
pub struct Regiao {
pub:
id int
sigla string
nome string
}