File size: 13,244 Bytes
8921f4d fe9665f 8921f4d b77bffb 8921f4d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
"""
API routes for dados.gov.br integration.
This module exposes endpoints for searching and retrieving
data from the Brazilian Open Data Portal.
"""
import logging
from typing import Any, Dict, List, Optional
from fastapi import APIRouter, Depends, HTTPException, Path, Query
from pydantic import BaseModel, Field
from src.api.auth import get_current_user
from src.core.exceptions import ValidationError
from src.services.dados_gov_service import DadosGovService
from src.tools.dados_gov_api import DadosGovAPIError
from src.tools.dados_gov_models import (
Dataset,
DatasetSearchResult,
Organization,
Resource,
)
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/dados-gov", tags=["dados.gov.br"])
class DatasetSearchRequest(BaseModel):
"""Request model for dataset search"""
keywords: Optional[List[str]] = Field(
None,
description="Keywords to search for",
example=["transparência", "gastos", "contratos"],
)
organization: Optional[str] = Field(
None,
description="Filter by organization",
example="ministerio-da-saude",
)
data_format: Optional[str] = Field(
None,
description="Preferred data format",
example="csv",
)
limit: int = Field(
20,
ge=1,
le=100,
description="Maximum number of results",
)
class DataAvailabilityResponse(BaseModel):
"""Response model for data availability analysis"""
topic: str
total_datasets: int
analyzed_datasets: int
organizations: Dict[str, int]
formats: Dict[str, int]
years_covered: List[str]
geographic_coverage: Dict[str, int]
update_frequency: Dict[str, int]
@router.get(
"/search",
response_model=DatasetSearchResult,
summary="Search datasets",
description="Search for datasets in the Brazilian Open Data Portal",
)
async def search_datasets(
query: Optional[str] = Query(
None,
description="Search query",
example="educação básica",
),
organization: Optional[str] = Query(
None,
description="Filter by organization",
example="inep",
),
tags: Optional[List[str]] = Query(
None,
description="Filter by tags",
example=["educação", "censo"],
),
format: Optional[str] = Query(
None,
description="Filter by data format",
example="csv",
),
limit: int = Query(
10,
ge=1,
le=100,
description="Number of results per page",
),
offset: int = Query(
0,
ge=0,
description="Pagination offset",
),
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Search for datasets in dados.gov.br.
This endpoint allows searching the Brazilian Open Data Portal
for datasets matching specific criteria.
"""
service = DadosGovService()
try:
# Use the service to search
if query or tags:
keywords = []
if query:
keywords.append(query)
if tags:
keywords.extend(tags)
result = await service.search_transparency_datasets(
keywords=keywords,
organization=organization,
data_format=format,
limit=limit,
)
else:
# Direct API call for browsing without keywords
client = service.client
api_result = await client.search_datasets(
organization=organization,
format=format,
limit=limit,
offset=offset,
)
result = DatasetSearchResult(
count=api_result.get("count", 0),
results=[Dataset(**ds) for ds in api_result.get("results", [])],
)
return result
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error searching datasets",
)
finally:
await service.close()
@router.get(
"/dataset/{dataset_id}",
response_model=Dataset,
summary="Get dataset details",
description="Get complete information about a specific dataset",
)
async def get_dataset(
dataset_id: str,
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Get detailed information about a dataset.
Returns complete dataset information including all resources
and metadata.
"""
service = DadosGovService()
try:
dataset = await service.get_dataset_with_resources(dataset_id)
return dataset
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
if e.status_code == 404:
raise HTTPException(
status_code=404,
detail=f"Dataset '{dataset_id}' not found",
)
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error retrieving dataset",
)
finally:
await service.close()
@router.get(
"/resource/{resource_id}/url",
response_model=Dict[str, str],
summary="Get resource download URL",
description="Get the direct download URL for a dataset resource",
)
async def get_resource_url(
resource_id: str,
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Get the download URL for a resource.
Returns the direct URL to download the resource file.
"""
service = DadosGovService()
try:
url = await service.get_resource_download_url(resource_id)
return {"resource_id": resource_id, "download_url": url}
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
if e.status_code == 404:
raise HTTPException(
status_code=404,
detail=f"Resource '{resource_id}' not found",
)
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error retrieving resource",
)
finally:
await service.close()
@router.get(
"/organizations",
response_model=List[Organization],
summary="List organizations",
description="List all organizations that publish open data",
)
async def list_organizations(
limit: int = Query(
50,
ge=1,
le=200,
description="Maximum number of organizations",
),
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
List government organizations.
Returns a list of all organizations that publish datasets
on the open data portal, sorted by number of datasets.
"""
service = DadosGovService()
try:
organizations = await service.list_government_organizations()
return organizations[:limit]
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error listing organizations",
)
finally:
await service.close()
@router.post(
"/search/transparency",
response_model=DatasetSearchResult,
summary="Search transparency datasets",
description="Search for transparency-related datasets with filters",
)
async def search_transparency_datasets(
request: DatasetSearchRequest,
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Search for transparency-related datasets.
This endpoint provides a specialized search for datasets
related to government transparency, spending, and accountability.
"""
service = DadosGovService()
try:
result = await service.search_transparency_datasets(
keywords=request.keywords,
organization=request.organization,
data_format=request.data_format,
limit=request.limit,
)
return result
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error searching transparency datasets",
)
finally:
await service.close()
@router.get(
"/analyze/{topic}",
response_model=DataAvailabilityResponse,
summary="Analyze data availability",
description="Analyze what data is available for a specific topic",
)
async def analyze_data_availability(
topic: str = Path(
...,
description="Topic to analyze",
example="educação",
),
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Analyze data availability for a topic.
This endpoint analyzes what datasets are available for a specific
topic, including formats, organizations, and temporal coverage.
"""
service = DadosGovService()
try:
analysis = await service.analyze_data_availability(topic)
return DataAvailabilityResponse(**analysis)
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error analyzing data availability",
)
finally:
await service.close()
@router.get(
"/spending-data",
response_model=List[Dataset],
summary="Find government spending data",
description="Find datasets related to government spending and expenses",
)
async def find_spending_data(
year: Optional[int] = Query(
None,
ge=2000,
le=2030,
description="Filter by year",
),
state: Optional[str] = Query(
None,
description="Filter by state code",
example="SP",
),
city: Optional[str] = Query(
None,
description="Filter by city name",
example="São Paulo",
),
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Find government spending datasets.
Search for datasets containing information about government
expenses, payments, and budget execution.
"""
service = DadosGovService()
try:
datasets = await service.find_government_spending_data(
year=year,
state=state,
city=city,
)
return datasets
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error finding spending data",
)
finally:
await service.close()
@router.get(
"/procurement-data",
response_model=List[Dataset],
summary="Find procurement data",
description="Find datasets related to public procurement and contracts",
)
async def find_procurement_data(
organization: Optional[str] = Query(
None,
description="Filter by organization",
),
modality: Optional[str] = Query(
None,
description="Procurement modality",
example="pregão",
),
current_user: Dict[str, Any] = Depends(get_current_user),
):
"""
Find procurement-related datasets.
Search for datasets containing information about public
tenders, contracts, and procurement processes.
"""
service = DadosGovService()
try:
datasets = await service.find_procurement_data(
organization=organization,
modality=modality,
)
return datasets
except DadosGovAPIError as e:
logger.error(f"API error: {e}")
raise HTTPException(
status_code=e.status_code or 500,
detail=str(e),
)
except Exception as e:
logger.error(f"Unexpected error: {e}")
raise HTTPException(
status_code=500,
detail="Error finding procurement data",
)
finally:
await service.close() |