Saltar al contenido principal

Introducción

La API de EdocAPI está diseñada para la creación, modificación y consulta de documentos electrónicos de transporte. Esta API facilita a los desarrolladores la interacción con el sistema para gestionar documentos relacionados con el transporte de mercancías de manera eficiente y segura.

Objetivos​

  • Creación de documentos: Permite generar nuevos documentos electrónicos de transporte.
  • Modificación de documentos: Facilita la actualización de documentos existentes.
  • Consulta de documentos: Proporciona métodos para recuperar documentos en formatos como HTML y PDF.
  • Integración con servicios: Conecta con servicios de almacenamiento y renderizado de vistas para una gestión efectiva.

Estructura del proyecto​

El proyecto está organizado de la siguiente manera:

  • Controllers/: Contiene los controladores que manejan las solicitudes HTTP.
  • Models/: Define las clases de modelos de datos utilizados por la API.
  • Services/: Implementa servicios como la conexión a MongoDB y el renderizado de vistas.
  • Views/: Contiene las plantillas de vistas utilizadas para generar el contenido HTML de los documentos.
  • Plugins/: Incluye librerías y herramientas adicionales utilizadas por la API.

Tecnologías utilizadas​

  • .NET 8.0: Framework utilizado para desarrollar la API.
  • MongoDB: Base de datos NoSQL utilizada para almacenar los documentos.
  • RazorLight: Motor de plantillas utilizado para renderizar las vistas HTML.
  • Spire.Pdf: Librería utilizada para la conversión de HTML a PDF

Requisitos del sistema​

  • Sistema Operativo: Windows 11
  • Entorno de Desarrollo: Visual Studio Code
  • Lenguaje de Programación: C#
  • Dependencias: Detalladas en el archivo EdocAPI.csproj

Configuración inicial​

  1. Clonar el Repositorio:

    git clone https://github.com/tu-repositorio/API-EDOCS.git

  2. Instalar dependencias:

    dotnet restore

  3. Configurar la Base de Datos:

    Editar el archivo appsetings.json con las credenciales de MongoDB.

  4. Ejecutar la Aplicación:

    dotnet run

Autenticación y seguridad​

La API utiliza mecanismos de autenticación basados en tokens para asegurar las comunicaciones y proteger los datos sensibles.

Contacto​

Para más información o soporte, por favor contacta al equipo de desarrollo en correo@ejemplo.com.