Skip to content

Releases: tuxevil/openAPI-ec

v1.0.0

17 Jun 01:05

Choose a tag to compare

Resumen

Primer corte de release del proyecto. Define el contrato v1 de la API y los cimientos operacionales para entornos de produccion.

Novedades

API

  • Capa de integracion API-first sobre Laravel 13 + PHP 8.4.
  • 18 endpoints REST bajo /api/v1 agrupados en dos subsistemas:
    • Contifico (contabilidad): contactos, productos, facturas, pagos, stock.
    • Payphone (payment gateway): ventas, links, consulta de transacciones, reversos.
  • Especificacion OpenAPI 3.1 servida en /api/docs/openapi.yaml y Swagger UI en /api/docs.
  • Contrato de respuesta normalizado: { provider, operation, externalId, status, data, providerResponse }.
  • Codigos de error tipados: invalid_internal_token, validation_failed, provider_timeout, provider_upstream_error, provider_request_error, rate_limited, internal_error.

Seguridad

  • Autenticacion interna por bearer token con hash_equals (comparacion de tiempo constante).
  • Rate limiting de 60 req/min por sistema interno, con respuesta JSON 429.
  • Filtrado automatico de details.body y details.exception en respuestas de error cuando APP_DEBUG=false.
  • ProviderException no se reporta al log por defecto: si el disco de logs falla, la API sigue respondiendo con el 504/502 correcto.
  • vendor/bin/pint --test y composer audit ejecutados en CI.

Operacion

  • Imagen Docker reproducible: PHP 8.4-fpm-alpine + Nginx 1.27.
  • docker/entrypoint.sh corrige los permisos de storage/ en cada arranque.
  • Health check HTTP en GET /up.
  • Suite de pruebas: 61 tests / 222 aserciones, 100 % verde.

Comunidad

  • LICENSE MIT, copyright 2026 Sebastian Real.
  • SECURITY.md con politica de divulgacion responsable.
  • CODE_OF_CONDUCT.md (Contributor Covenant v2.1, en espanol).
  • CONTRIBUTING.md con flujo de trabajo y convenciones.
  • .github/PULL_REQUEST_TEMPLATE.md y .github/ISSUE_TEMPLATE/config.yml.
  • Discussions habilitadas para preguntas e ideas.

Breaking changes

Ninguno respecto a la rama main (este es el primer release tag).

Compatibilidad

Componente Version
PHP 8.4
Laravel 13.x
OpenAPI 3.1

Como empezar

git clone https://github.com/tuxevil/openAPI-ec.git
cd openAPI-ec
git checkout v1.0.0
cp .env.example .env
docker compose run --rm app php artisan key:generate
docker compose up --build -d

Documentacion completa en el README y en /api/docs una vez levantado el servicio.

Hash de integridad

Tag anotado en Git con la firma GPG del autor. SHA-256 del tarball disponible en la pagina del release.

Reporte de vulnerabilidades

Privado a tuxevil@gmail.com o via GitHub Security Advisories. Ver SECURITY.md.