浅念
ff7e9cb1d9
Adds the read-only API surface the upcoming Vue frontend needs to browse all
mirrored entities. Follows the existing customer-router pattern: Annotated
deps, Page[T] envelope, select+where+order_by, count() for total.
Endpoints (all GET):
* /api/departments -> list[DepartmentOut] (path-ordered, plain list)
* /api/staff -> Page[StaffOut] (department_id, is_on_job filters)
* /api/accounts -> Page[AccountOut] (channel filter; unified
wechat+whatsapp projection built in memory)
* /api/messages -> Page[MessageOut] (channel/owner/talker/room/
[start,end] filters; ordered timestamp asc)
* /api/groups -> Page[GroupOut] (channel/owner filters)
* /api/groups/{id}/members -> list[GroupMemberOut] (404 on unknown room)
* /api/calls -> Page[PhoneCallOut] (channel/user/time window;
ordered start_call_time desc)
* /api/sms -> Page[SmsOut] (user/time window; create_time desc)
* /api/sync/status -> {states, recent_runs} monitor payload
Schemas (Pydantic v2, from_attributes=True): MessageOut, GroupOut,
GroupMemberOut, PhoneCallOut, SmsOut, DepartmentOut, StaffOut, AccountOut
(unified across two tables), SyncStateOut, SyncRunOut, SyncStatusOut.
Only human-relevant fields per entity are exposed.
Tests: per-router TDD via httpx ASGITransport against an in-memory SQLite
override of get_session. A shared make_client factory in conftest.py builds
the seeded client, deduping the ~40-line fixture across the six new files.
41 new tests cover shape + every documented filter + pagination + ordering
(nulls-last verified on all desc/asc time columns).
Suite: 226 -> 267 passing. ruff check clean.
Co-Authored-By: Claude <noreply@anthropic.com>
71 lines
2.2 KiB
Python
71 lines
2.2 KiB
Python
"""FastAPI app for the yunke data-mirror viewing API.
|
|
|
|
Run locally with::
|
|
|
|
uvicorn app.api.main:app --reload
|
|
|
|
Includes:
|
|
* ``GET /api/health`` -> ``{"status": "ok"}`` liveness probe.
|
|
* ``GET /api/customers`` (see :mod:`app.api.routers.customer`).
|
|
* ``GET /api/media/{media_hash}`` (see :mod:`app.api.routers.media`).
|
|
* ``GET /api/departments`` / ``/api/staff`` / ``/api/accounts``
|
|
(see :mod:`app.api.routers.organization`).
|
|
* ``GET /api/messages`` (see :mod:`app.api.routers.messages`).
|
|
* ``GET /api/groups`` / ``/api/groups/{room_id}/members``
|
|
(see :mod:`app.api.routers.groups`).
|
|
* ``GET /api/calls`` (see :mod:`app.api.routers.calls`).
|
|
* ``GET /api/sms`` (see :mod:`app.api.routers.sms`).
|
|
* ``GET /api/sync/status`` (see :mod:`app.api.routers.sync`).
|
|
|
|
CORS is configured permissively (wildcard origin, no credentials) so the local
|
|
frontend can call the API during development.
|
|
|
|
Auth (Task 2.9): a single shared-token dependency (:func:`app.api.auth.require_auth`)
|
|
is applied globally on the app. Trust model: when ``Settings.api_token`` is
|
|
empty (the default) auth is disabled — we trust the network boundary (this is a
|
|
local/intranet tool). When a token is configured, every request must present it
|
|
via ``Authorization: Bearer <token>`` or ``?token=``. ``/api/health`` is exempt
|
|
so liveness probes work without the token. See :mod:`app.api.auth`.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from fastapi import Depends, FastAPI
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
|
|
from app.api.auth import require_auth
|
|
from app.api.routers import (
|
|
calls,
|
|
customer,
|
|
groups,
|
|
media,
|
|
messages,
|
|
organization,
|
|
sms,
|
|
sync,
|
|
)
|
|
|
|
app = FastAPI(title="yunke data mirror", dependencies=[Depends(require_auth)])
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=["*"],
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
app.include_router(customer.router)
|
|
app.include_router(media.router)
|
|
app.include_router(organization.router)
|
|
app.include_router(messages.router)
|
|
app.include_router(groups.router)
|
|
app.include_router(calls.router)
|
|
app.include_router(sms.router)
|
|
app.include_router(sync.router)
|
|
|
|
|
|
@app.get("/api/health")
|
|
async def health() -> dict[str, str]:
|
|
"""Trivial liveness probe."""
|
|
return {"status": "ok"}
|