Dateien nach „doc“ hochladen

This commit is contained in:
Markus Benjamin Tabler 2026-08-16 19:58:55 +00:00
parent 6097199701
commit c2933f6a9a
3 changed files with 76 additions and 0 deletions

20
doc/architecture.mmd Normal file
View file

@ -0,0 +1,20 @@
graph TD
subgraph Backend FastAPI
API[FastAPI Server<br/>fastAPI.py]
COMP[Endpoint Compare<br/>endpoint_compare.py]
end
subgraph Core Logic & Scraping
CRON((Scheduler / Cronjob))
SCRAPE[WhatsNew Fetcher<br/>fetchWhatsNew.py]
EDGE[Edge WebDriver<br/>msedgedriver.exe]
end
C[Client / Developer] -->|HTTP Requests| API
API --> COMP
CRON -->|Einmal im Monat| SCRAPE
SCRAPE -->|Automates| EDGE
EDGE -.->|Scrapes| SAP[Whats new for SAP Digital Manufacturing]
SCRAPE -.->|Speichert Daten für| COMP

28
doc/sequence_phase_1.mmd Normal file
View file

@ -0,0 +1,28 @@
sequenceDiagram
autonumber
participant Scraper as WhatsNew Scraper<br/>(Core/fetchWhatsNew.py)
participant Edge as Edge WebDriver<br/>(msedgedriver.exe)
participant SAP as SAP DM Webseiten<br/>(Extern)
participant Compare as Datenverarbeitung / Speicher<br/>(z.B. endpoint_compare.py)
Note over Scraper: Rufe aktuelle 'What's New' Daten ab
activate Scraper
Scraper->>Edge: Initialisiere Browser-Instanz
activate Edge
Note right of Edge: Nutzt lokale msedgedriver.exe
Scraper->>Edge: Navigiere zu SAP DM Deprecation Pages
Edge->>SAP: HTTP Request (Lade Seite)
activate SAP
SAP-->>Edge: HTML Content
deactivate SAP
Scraper->>Edge: Extrahiere relevante API-Daten (DOM Scraping)
Edge-->>Scraper: Rohdaten (Deprecated APIs List)
Scraper->>Edge: Schließe Browser-Instanz
deactivate Edge
Scraper-->>Compare: Strukturierte Liste veralteter APIs
deactivate Scraper

28
doc/sequence_phase_2.mmd Normal file
View file

@ -0,0 +1,28 @@
sequenceDiagram
autonumber
actor Dev as Entwickler / Client
participant API as FastAPI Server<br/>(API/fastAPI.py)
participant Compare as Endpoint Compare<br/>(API/endpoint_compare.py)
participant Data as Datenablage<br/>(Ergebnis aus Phase 1)
Note over Dev, API: Phase 2: API Request & Vergleich
Dev->>API: API-Anfrage (z.B. Liste der genutzten Endpunkte)
activate API
API->>Compare: Aufruf compare_string(genutzte_endpunkte)
activate Compare
Compare->>Data: Lade aktualisierte Deprecation-Liste
activate Data
Note right of Data: Greift auf die Daten zu,<br/>die der Scraper<br/>zuvor gespeichert hat.
Data-->>Compare: Strukturierte Liste veralteter APIs
deactivate Data
Note right of Compare: Logischer Abgleich:<br/>Welche genutzten APIs<br/>stehen auf der Deprecation-Liste?
Compare-->>API: Vergleichsergebnis (Matches, Warnungen etc.)
deactivate Compare
API-->>Dev: HTTP 200 OK (JSON Response)
deactivate API