What is an AsyncAPI Specification?

1
asyncapi: 3.0.0
2
info:
3
  title: User Notification Service
4
  version: 1.0.0
5
  description: |
6
    Service that handles user notifications through various channels
7
    including email, SMS, and push notifications.
8
channels:
9
  user/signup:
10
    address: user/signup
11
    messages:
12
      UserSignedUp:
13
        $ref: '#/components/messages/UserSignedUp'
14
  notification/send:
15
    address: notification/send
16
    messages:
17
      SendNotification:
18
        $ref: '#/components/messages/SendNotification'
19
operations:
20
  onUserSignup:
21
    action: receive
22
    channel:
23
      $ref: '#/channels/user~1signup'
24
    summary: User signup event
25
    description: Triggered when a user signs up for the service
26
  sendNotification:
27
    action: send
28
    channel:
29
      $ref: '#/channels/notification~1send'
30
    summary: Send notification
31
    description: Send a notification to a user
32
components:
33
  messages:
34
    UserSignedUp:
35
      name: UserSignedUp
36
      title: User Signed Up
37
      summary: User has signed up for the service
38
      contentType: application/json
39
      payload:
40
        $ref: '#/components/schemas/User'
41
    SendNotification:
42
      name: SendNotification
43
      title: Send Notification
44
      summary: Send a notification to a user
45
      contentType: application/json
46
      payload:
47
        $ref: '#/components/schemas/Notification'
48
  schemas:
49
    User:
50
      type: object
51
      properties:
52
        id:
53
          type: string
54
          format: uuid
55
          description: Unique identifier for the user
56
        email:
57
          type: string
58
          format: email
59
          description: User's email address
60
        name:
61
          type: string
62
          description: User's full name
63
        createdAt:
64
          type: string
65
          format: date-time
66
          description: When the user was created
67
      required:
68
        - id
69
        - email
70
        - name
71
    Notification:
72
      type: object
73
      properties:
74
        userId:
75
          type: string
76
          format: uuid
77
          description: ID of the user to notify
78
        type:
79
          type: string
80
          enum: [email, sms, push]
81
          description: Type of notification to send
82
        message:
83
          type: string
84
          description: Message content
85
        priority:
86
          type: string
87
          enum: [low, medium, high, urgent]
88
          default: medium
89
          description: Priority level of the notification
90
      required:
91
        - userId
92
        - type
93
        - message