# เอกสาร API
DDB API ประกอบด้วย microservices ที่แตกต่างกันจำนวนมาก ด้านล่างคุณสามารถดูบริการที่แตกต่างกันที่คุณสามารถโต้ตอบได้พร้อมกับวิธีการตรวจสอบสิทธิ์และรับการเข้าถึง
# Microservices
API ของเราถูกแยกออกเป็น *6 microservices *.
| Microservice | วัตถุประสงค์ |
|---|---|
| บริการบริบทด้านสิ่งแวดล้อม | บริการบริบทสิ่งแวดล้อมเก็บข้อมูลโครงการปัจจุบันที่ใช้ใน DDB |
| บริการพารามิเตอร์ | บริการที่ให้ข้อมูลเกี่ยวกับสินทรัพย์และพารามิเตอร์ในโครงการ |
| บริการข้อมูลเมตาพารามิเตอร์ | บริการที่ให้ข้อมูลเมตาเกี่ยวกับสินทรัพย์และพารามิเตอร์ในโครงการ |
| บริการข้อมูลอ้างอิง | ข้อมูลแหล่งข้อมูลที่ใช้เพื่อกำหนดการอ้างอิงไปยังแหล่งข้อมูลภายในและภายนอก |
| บริการ QA | โฮสต์ข้อมูลบริการ QA |
| บริการความคิดเห็น | บริการความคิดเห็นมีวัตถุประสงค์เพื่อโฮสต์ความคิดเห็นที่เกี่ยวข้องกับระบบที่หลากหลายของระบบสินทรัพย์และพารามิเตอร์ |
Microservice แต่ละตัวมีอินสแตนซ์อิสระสำหรับแต่ละสภาพแวดล้อมทั้งสาม
สำหรับการสรุปวัตถุประสงค์ของแต่ละสภาพแวดล้อมให้ดู ที่นี่ .
ตารางต่อไปนี้มีลิงก์ไปยัง microservice แต่ละตัวสำหรับแต่ละสภาพแวดล้อม
| Microservice | *การพัฒนา | กล่องทราย | การผลิต |
|---|---|---|---|
| บริการบริบทด้านสิ่งแวดล้อม | environmentcontextบริการ (opens new window) | environmentcontextบริการ (opens new window) | environmentcontextบริการ (opens new window) |
| บริการพารามิเตอร์ | parameter_service (opens new window) | parameter_service (opens new window) | parameter_service (opens new window) |
| บริการข้อมูลเมตาพารามิเตอร์ | parametermetadataบริการ (opens new window) | parametermetadataบริการ (opens new window) | parametermetadataบริการ (opens new window) |
| บริการข้อมูลอ้างอิง | reference_data_service (opens new window) | reference_data_service (opens new window) | reference_data_service (opens new window) |
| บริการ QA | qa_service (opens new window) | qa_service (opens new window) | qa_service (opens new window) |
| บริการความคิดเห็น | ความคิดเห็น _Service (opens new window) | ความคิดเห็น _Service (opens new window) | ความคิดเห็น _Service (opens new window) |
*เฉพาะทีมพัฒนา DDB เท่านั้นที่ควรใช้สภาพแวดล้อมการพัฒนา
บริการที่แตกต่างกันทั้งหมดใช้ URL พื้นฐานเดียวกัน (เช่นhttps://ddb.arup.com (opens new window)) และถูกส่งไปยัง URL ของพวกเขา
แต่ละ microservice ถูกกำหนดในการใช้ Open API 3.0 (Swagger) หากคุณไม่แน่ใจเกี่ยวกับจุดสิ้นสุดของ API ที่เกี่ยวข้องกับกระบวนการของคุณติดต่อทีมออนบอร์ดเพื่อรับการสนับสนุนเพิ่มเติม
# การไหลของ API
ไดอะแกรมด้านล่างคือการสรุปขั้นตอนที่จะทำเมื่อพยายามรับและโพสต์พารามิเตอร์ไปยัง DDB
แผนภาพการโทร API ที่จำเป็น
รุ่น →