The Comunidades Vecinos API is a Spring Boot REST service that powers the full lifecycle of a residential homeowners community — from user and fee management to document uploads and financial movements. Every resource is exposed under theDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/GuillermoNavarro/Proyecto_comunidades/llms.txt
Use this file to discover all available pages before exploring further.
/api prefix at http://localhost:8081 (the port is configurable via the server.port property in application.properties). All responses use JSON, and all state is kept in the database — the server itself is completely stateless.
Base URL
/api. For example, the login endpoint is reachable at:
The port
8081 is set by server.port in application.properties. Change it there if you need to run the backend on a different port.Authentication
Every request to the API — except the three public paths listed below — must include a valid JSON Web Token in theAuthorization header:
POST /api/login. The server validates the token on every request without performing a database lookup; all necessary identity information is embedded directly in the JWT claims.
Public endpoints (no token required)
| Path | Purpose |
|---|---|
/api/login | Obtain a JWT token (POST) |
/swagger-ui/** | Interactive API documentation UI |
/v3/api-docs/** | OpenAPI 3 specification (JSON) |
The API uses
SessionCreationPolicy.STATELESS — no cookies and no server-side session are ever created. Every single request must carry its own JWT.Swagger UI
An interactive OpenAPI 3 interface is available at:Response format
All endpoints returnapplication/json bodies, with the single exception of POST /api/login, which returns a raw JWT string (plain text) rather than a JSON-wrapped object.
Endpoint groups
Authentication
Obtain a JWT token via
POST /api/login. The entry point for every client session.Communities
CRUD operations for residential communities (
/api/comunidades).Users
Create, read, update, and deactivate community members (
/api/usuarios).Fees
Define and manage periodic fees charged to residents (
/api/cuotas).Receipts
Track fee receipts issued to individual users (
/api/recibos).Movements
Financial ledger entries for income and expenses (
/api/movimientos).Documents
Upload and retrieve PDF documents for a community (
/api/documentos).Publications
Publish and read community news and announcements (
/api/publicaciones).Role permissions
The API enforces three roles —USER, ADMIN, and SUPER_ADMIN. The table below summarises the general permission level each role holds over each endpoint group.
| Endpoint group | USER | ADMIN | SUPER_ADMIN |
|---|---|---|---|
/api/login | ✓ | ✓ | ✓ |
/api/usuarios | Read own profile | Full access within own community | Full platform access |
/api/comunidades | — | Read own community | Full CRUD |
/api/cuotas | — | Full access | Full access |
/api/recibos | Read own receipts | Full access within community | — |
/api/movimientos | Read own / community movements | Full access | Full access |
/api/documentos | Read | Full access | Full access |
/api/publicaciones | Read | Full access | — |