Saltar al contenido principal

Estructura de archivos del conector

Adjunto se encuentra un árbol de archivos para demostrar cómo están organizados los archivos de los conectores como un proyecto de TypeScript.

Los archivos cuyo nombre termina con ^ se refieren a un archivo opcional, de lo contrario, son obligatorios.

ConnectorRootDir/
├── package.json
├── README.md
├── logo.svg
├── logo-dark.svg^
└── src/
    ├── index.ts
    ├── index.test.ts
    ├── types.ts
    ├── constant.ts
    ├── mock.ts^
    ├── utils.ts^
    ├── utils.test.ts^
    └── ...

Basado en la estructura de archivos del conector, revisemos cada archivo y descubramos cómo funcionan juntos como un sistema completo.

package.json​

package.json contiene configuraciones de este repositorio del conector. Se fusionará con un package.json compartido, que contiene dependencias y atributos comunes.

README.md​

README.md es una guía detallada para configurar la configuración del conector.

logo.svg​

logo.svg es un archivo que almacena el logotipo del conector en formato de imagen vectorial.

logo-dark.svg​

El archivo logo-dark.svg contiene el gráfico vectorial del logotipo del conector en modo oscuro.

nota

Consulta logo del conector para saber más sobre la relación entre logo.svg y logo-dark.svg.

index.ts​

index.ts es el archivo para la implementación de la clase del conector.

index.test.ts​

index.test.ts es un archivo que contiene pruebas unitarias (UTs) correspondientes para las implementaciones en index.ts.

types.ts​

types.ts es donde debes definir los tipos de las variables.

constant.ts​

constant.ts es donde debes colocar las constantes relacionadas con el conector, incluidos los endpoints, metadatos del conector, etc.

mock.ts​

mock.ts es el archivo donde puedes colocar valores simulados para propósitos de prueba.

utils.ts​

utils.ts es el archivo donde los desarrolladores colocan funciones de utilidad, y utils.test.ts debe contener las UTs relacionadas.