Markdown Editor

集成架构师套件

正确连接各系统:集成战略、API 指南、接口设计、事件驱动架构、API 管理、B2B 与 EDI、REST 与事件规范及 SLA。

第 1 步

战略

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

    完整

    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)

    完整

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

第 2 步

设计

  1. Integration Design Document Template (Enterprise Integration Patterns)

    完整

    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)

    完整

    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)

    完整

    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)

    完整

    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)
第 3 步

规范说明

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

    完整

    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)

    完整

    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

    完整

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

第 4 步

运维

  1. Observability Specification Template (OpenTelemetry)

    完整

    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

    完整

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