# API -dokumentation
DDB API består af en række forskellige mikroservices. Nedenfor kan du se de forskellige tjenester, du kan interagere med, sammen med, hvordan man autentificerer og får adgang.
# Mikroservices
Vores API er adskilt til *6 mikroservices *.
Microservice | Formål |
---|---|
Miljøstjeneste | Miljøkonteksttjenesten gemmer de aktuelle projekter, der bruges i DDB. |
Parametertjeneste | En tjeneste, der leverer oplysninger om aktiver og parametre om projekter. |
Parameter Metadata Service | En tjeneste, der leverer metadata på aktiver og parametre på projekter. |
Referencedatatjeneste | Kildedataoplysninger, der bruges til at definere henvisninger til interne og eksterne kilder. |
QA -service | Er vært for QA -servicedata. |
Kommentarer Service | Kommentarer -tjenesten er beregnet til at være vært for trådede kommentarer, der vedrører forskellige systemer, aktiver og parametre. |
Hver mikroservice har en uafhængig forekomst for hvert af de tre miljøer. For en sammenfattelse af formålet med hvert miljø, se her .
Følgende tabel inkluderer links til hver mikroservice for hvert miljø.
Microservice | *Udvikling | Sandkasse | Produktion |
---|---|---|---|
Miljøstjeneste | Miljø_context_service (opens new window) | Miljø_context_service (opens new window) | Miljø_context_service (opens new window) |
Parametertjeneste | parameter_service (opens new window) | parameter_service (opens new window) | parameter_service (opens new window) |
Parametermetadatatjeneste | Parameter_metadata_service (opens new window) | Parameter_metadata_service (opens new window) | Parameter_metadata_service (opens new window) |
Referencedatatjeneste | Reference_data_service (opens new window) | Reference_data_service (opens new window) | Reference_data_service (opens new window) |
QA -service | QA_Service (opens new window) | QA_Service (opens new window) | QA_Service (opens new window) |
Kommentarer Service | kommentarer_service (opens new window) | kommentarer_service (opens new window) | kommentarer_service (opens new window) |
*Kun DDB -udviklingsholdet skal bruge udviklingsmiljøet
Alle de forskellige tjenester bruger den samme base -URL (f.eks.https://ddb.arup.com (opens new window)) og dirigeres til ifølge deres URL.
Hver mikroservice er defineret i anvendelse af Open API 3.0 (Swagger). Hvis du er usikker på API -endepunkter relateret til din proces, skal du kontakte Onboarding -teamet for mere support.
# API Flow
Diagram nedenfor opsummerer trin, der skal tages, når du prøver at få og efter parametre til DDB.
Diagram over API -opkald, der er nødvendige