Markdown Editor
Mở trình soạn thảo

Bộ mẫu kiến trúc tích hợp

Kết nối hệ thống đúng cách: chiến lược tích hợp, hướng dẫn API, thiết kế giao diện, kiến trúc hướng sự kiện, quản lý API, B2B và EDI, đặc tả REST và sự kiện, SLA.

Bước 1

Chiến lược

  1. Integration Strategy Template (EIP, AsyncAPI 3.1, OpenAPI 3.2)

    Đầy đủ

    Drivers, landscape and debt, principles, style decision tree, system/process/experience layers, platform scoring, canonical policy, CoE RACI, roadmap, KPIs

    Enterprise Integration Patterns (names); AsyncAPI 3.1.0; CloudEvents 1.0.2; OpenAPI 3.2

  2. API Design Guidelines Template (Company Style Guide)

    Đầy đủ

    Company API style guide: naming, methods, status codes, RFC 9457 errors, pagination, versioning, security, webhooks, governance

Bước 2

Thiết kế

  1. Integration Design Document Template (Enterprise Integration Patterns)

    Đầy đủ

    Integration design: landscape, catalogue, per-flow pattern, field mapping, transformation, retries, idempotency, canonical model, cutover

    Enterprise Integration Patterns (Hohpe and Woolf, 2003); API-led layers; CloudEvents 1.0.2

  2. Event-Driven Architecture Design Template (AsyncAPI 3.1, CloudEvents)

    Đầy đủ

    Business events, event types, broker topology, topic naming and partitions, event catalogue, CloudEvents envelope, schema compatibility, outbox and CDC, replay

    AsyncAPI 3.1.0; CloudEvents 1.0.2

  3. API Management Platform Design Template (OpenAPI 3.2, OAuth, FAPI 2.0)

    Đầy đủ

    API products, consumer onboarding, gateway tiers, OAuth and sender-constrained tokens, rate plans, developer portal, versioning, analytics, monetisation, APIOps

    OpenAPI 3.2; RFC 9700; FAPI 2.0 Security Profile

  4. B2B EDI and File Transfer Design Template (X12, EDIFACT, AS2, AS4)

    Đầy đủ

    Partner landscape, X12 and EDIFACT versions, AS2, AS4, SFTP and API transports, canonical mapping, TA1/997/999/CONTRL acks, MFT rules, certificates, onboarding

    AS2 (RFC 4130); AS4 Profile of ebMS 3.0; ASC X12 and UN/EDIFACT (structure only)
Bước 3

Đặc tả

  1. REST API Specification Template (OpenAPI 3.2, RFC 9457)

    Đầy đủ

    HTTP/JSON API contract: auth, conventions, QUERY, streaming, pagination, RFC 9457 errors, endpoints, webhooks, OpenAPI 3.2 skeleton

    OpenAPI 3.2, RFC 9110, RFC 9457

  2. Event-Driven API Specification Template (AsyncAPI 3)

    Đầy đủ

    Async event contract: brokers, channels, operations, CloudEvents envelope, ordering, delivery, DLQ, schema evolution, AsyncAPI YAML

    AsyncAPI 3.1.0, CloudEvents 1.0.2

  3. Interface Control Document (ICD) Template

    Đầy đủ

    ICD between two systems – parties, requirements allocation, data element table, protocol sequence, errors, security, timing, change control

Bước 4

Vận hành

  1. Observability Specification Template (OpenTelemetry)

    Đầy đủ

    Observability spec: logs, metrics and traces standards, semantic conventions, log schema, RED/USE catalogue, sampling, alerts, privacy, cost

    OpenTelemetry concepts

  2. Service Level Agreement (SLA) Template

    Đầy đủ

    Service level agreement: definitions (SLA, SLO, SLI), service hours, availability formula, response times, exclusions, credits, signatures