# Dogfennaeth API
Mae'r API DDB yn cynnwys nifer o wahanol ficroservices. Isod gallwch weld y gwahanol wasanaethau y gallwch ryngweithio â nhw, ynghyd â sut i ddilysu a chael mynediad.
# Microservices
Mae ein API wedi'i wahanu i mewn *6 microservices *.
| Microservice | Pwrpas |
|---|---|
| Gwasanaeth Cyd -destun Amgylcheddol | Mae gwasanaeth cyd -destun yr amgylchedd yn storio'r data prosiectau cyfredol sy'n cael ei ddefnyddio yn DDB. |
| Gwasanaeth Paramedr | Gwasanaeth sy'n darparu gwybodaeth am asedau a pharamedrau ar brosiectau. |
| Gwasanaeth Metadata Paramedr | Gwasanaeth sy'n darparu metadata ar asedau a pharamedrau ar brosiectau. |
| Gwasanaeth Data Cyfeirio | Gwybodaeth ddata ffynhonnell a ddefnyddir i ddiffinio cyfeiriadau at ffynonellau mewnol ac allanol. |
| Gwasanaeth QA | Yn cynnal data gwasanaeth QA. |
| Gwasanaeth Sylwadau | Bwriad y gwasanaeth sylwadau yw cynnal sylwadau wedi'u threaded sy'n ymwneud ag amrywiaeth o systemau, asedau a pharamedrau. |
Mae gan bob microservice enghraifft annibynnol ar gyfer pob un o'r tri amgylchedd. Ar gyfer ailadrodd pwrpas pob amgylchedd, gweler yma .
Mae'r tabl canlynol yn cynnwys dolenni i bob microservice, ar gyfer pob amgylchedd.
| Microservice | *Datblygu | Tywod | Nghynhyrchiad |
|---|---|---|---|
| Gwasanaeth Cyd -destun Amgylcheddol | amgylchedd_context_ngwasanaeth (opens new window) | amgylchedd_context_ngwasanaeth (opens new window) | amgylchedd_context_ngwasanaeth (opens new window) |
| Gwasanaeth Paramedr | parameter_service (opens new window) | parameter_service (opens new window) | parameter_service (opens new window) |
| Gwasanaeth Metadata Paramedr | parameter_metadata_ngwasanaeth (opens new window) | parameter_metadata_ngwasanaeth (opens new window) | parameter_metadata_ngwasanaeth (opens new window) |
| Gwasanaeth Data Cyfeirio | Cyfeirnod_data_service (opens new window) | Cyfeirnod_data_service (opens new window) | Cyfeirnod_data_service (opens new window) |
| Gwasanaeth QA | qa_service (opens new window) | qa_service (opens new window) | qa_service (opens new window) |
| Gwasanaeth Sylwadau | Sylwadau_service (opens new window) | Sylwadau_service (opens new window) | Sylwadau_service (opens new window) |
*Dim ond tîm datblygu DDB ddylai fod yn defnyddio'r amgylchedd datblygu
Mae'r holl wahanol wasanaethau'n defnyddio'r un URL sylfaen (e.e.https://ddb.arup.com (opens new window)) ac yn cael eu cyfeirio i yn ôl eu URL.
Diffinnir pob microservice wrth ddefnyddio API 3.0 agored (swagger). Os ydych chi'n ansicr o bwyntiau terfyn API sy'n gysylltiedig â'ch proses, cysylltwch â'r tîm ar fwrdd y llong i gael mwy o gefnogaeth.
# Llif API
Mae'r diagram isod yn crynhoi camau i'w cymryd wrth geisio cael a phostio paramedrau i'r DDB.
Diagram o alwadau API sydd eu hangen
