AicaDocsApi

Aicadocsapi

Projekt des Computertechnik I Project.

Es wurde ein System zur Kontrolle der Dokumentation für das Qualitätsmanagementsystem des Unternehmens Pharmaceutical Laboratories von AICA+erstellt.

Eine API -Minimal wurde in ASP.NET Core 8 erstellt, die allen erfassten Anforderungen entspricht.

Eine Datenbank wurde in PostgreSql erstellt, die mit diesen Anforderungen robust sind, und für die Speicherung des Dateien Minio wurde verwendet

Problem

In AICA Laboratories möchten Sie die Kontrolle über die Dokumentation des Qualitätsmanagementsystems des Unternehmens behalten. Diese Dokumentation ist gemäß einem Umfang organisiert, der ein Rektor (im gesamten Unternehmen zutreffen) oder spezifisch sein kann (in einem EUB angewendet); ein Prozess, der einem der auf der Karte von Organisationsprozessen definierten Prozessen entspricht; und eine Art von Dokument, die von den Spezialisten des Qualitätsbereichs definiert wird. Der Code, Titel, Bearbeitung, Seiten, Gültigkeitsdatum und zwei zugehörige Dateien, eine im PDF -Format und ein anderes in Wort ist bekannt. Es ist erwünscht, ein System zu erstellen, das die Erstellung und Visualisierung dieser Dokumentation ermöglicht. Dazu werden die folgenden Anforderungen definiert:

• Schaffung von Dokumenten
• Dokumente suchen mit Filtern, die jeder Eigenschaft zugeordnet sind
• Laden Sie Dokumente herunter, in denen angegeben ist, dass die Datei heruntergeladen werden soll (PDF oder Word) und ein Grund zum Download

? ️ physisches Modell der Datenbank

? Verbindungskonfiguration zur Datenbank

Befolgen Sie die folgenden Schritte, um die Verbindung zur PostgreSQL -Datenbank zu konfigurieren:

1. Erstellen/Aktualisieren auf der Stammroute des Projekts Eine appsettings.json -Datei
2. Platzieren Sie in dieser Datei die folgenden Zeilen und ersetzen Sie in jedem Fall INFO durch die entsprechenden Informationen:

 }
    (...),
    "ConnectionStrings" : {
        "PostgreSQLConnection" : " Server=INFO;Port=INFO;Database=INFO;User Id=INFO;password=INFO "
    }
}

3. Wenn Sie nicht über die AICA -Datenbank verfügen, schreiben Sie den folgenden Befehl: dotnet ef database update . Stellen Sie sicher dotnet ef migrations add InitialCreate dass Sie die Migrations haben, wenn Sie den Befehl vorher nicht ausführen

? Minio -Verbindungskonfiguration

WICHTIG

MinIO Server muss installiert werden und der erforderliche Benutzer mit Schreibgenehmigung und dem bucket , in dem die Daten mit der Ordnerstruktur /pdf und /word konfiguriert sind.

Um die Minio -Verbindung zu konfigurieren, führen Sie die folgenden Schritte aus:

1. Erstellen/Aktualisieren auf der Stammroute des Projekts Eine appsettings.json -Datei
2. Platzieren Sie in dieser Datei die folgenden Zeilen und ersetzen Sie in jedem Fall INFO durch die entsprechenden Informationen:

 }
    (...),
    "Minio" : {
       "Endpoint" : " INFO " ,
       "AccessKey" : " INFO " ,
       "SecretKey" : " INFO " ,
       "Bucket" : " INFO "
    }
}

Eine weitere mögliche Möglichkeit, die API zu testen, besteht darin, den Minio -Cloud -Testserver zu verwenden, wobei die folgenden Daten in der Datei appsettings.json : JSON verwendet werden: JSON:

 }
    (...),
    "Minio" : {
       "Endpoint" : " play.min.io " ,
       "AccessKey" : " testuser " ,
       "SecretKey" : " testuser " ,
       "Bucket" : " aica-docs "
    }
} 

Einsatz

Notiz

Diese Bereitstellungen dienen nur dazu, die API in Bereitstellungsumgebungen zu testen, sondern nicht für die umfassende Verwendung.

Es wurde eine Testbereitstellung der 3 grundlegenden Dienste der API durchgeführt:

• ASP.NET Server -Bereitstellung in Render
• Bereitstellung der Datenbank in Elephantsql
• Bereitstellung von Eisenbahnminio -Server -Bereitstellung

? Aicadocs UI

Ein Test auf Razor Pages wurde durchgeführt, um zu veranschaulichen, wie ein mögliches API -Szenario sein würde. Die Seite befindet sich im folgenden Link

Automatisierte Integrationstests

Integrationstests wurden in der API im Zweig automatisiert und ausgeführt. Das letzte Ergebnis der Tests ist in der

Autoren

Lilian Rosa Rojas Rodríguez

Eduardo Alejandro González Martell

Tutoren

• Dr. Carlos Ramón López Paz
• MSC. Ana Lilian Infante Abreu

Spezialisten

Ing. Pedro Velázquez Borrero