Intro to AsyncAPI
0 likes•430 views
The document introduces the AsyncAPI specification for describing event-driven and data streaming systems, emphasizing its open standard and community support. It outlines the structure of AsyncAPI documents, including top-level elements like channels and components, and highlights its compatibility with other standards and tools for documentation and code generation. Key features include the ability to describe systems in a reusable way, track changes, and verify operations against the description.
![Components Section
A collection of reusable components
components:
messages:
DoorData:
name: door-sensor-data
title: Door Sensor Reading
description: Door sensor data
payload:
type: object
properties:
location:
type: string
state:
enum: ["open", "closed"]
@lornajane](https://image.slidesharecdn.com/intro-to-asyncapi-210525182231/85/Intro-to-AsyncAPI-11-320.jpg)
Intro to AsyncAPI
- 2. Introducing: AsyncAPI Specification for describing event-driven and data streaming systems. • https://asyncapi.com • Open standard • Active community • Supports Kafka! And MQTT, AMQP, WS .... @lornajane
- 3. Why use AsyncAPI? Describe your event-driven systems in a useful and reusable way. • Clearly track changes in a text-based description • Generate documentation and code • Verify system operations against description • Enclose existing payload descriptions (CloudEvents, Avro) within AsyncAPI @lornajane
- 4. Bunch of JSON/YAML asyncapi: '2.0.0' id: 'urn:com.github.lornajane.example1' info: contact: license: servers: local-kafka: channels: factorysensor: subscribe: message: payload: examples: components: securitySchemes: messages: @lornajane
- 7. AsyncAPI Structure Top-level elements: • asyncapi and id • info • servers • channels • tags • components @lornajane
- 8. Info Section Valuable metadata is held in info. info: title: Thingum Industries Sensors description: Keeping the factory and all the machines running nicely version: 1.0.0 contact: name: Lorna email: [email protected] url: https://github.com/aiven/thingum-industries license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html @lornajane
- 9. Channels Section Main operations are described here channels: door-sensor: description: Door sensors (external and internal) subscribe: operationId: DoorSensor description: Open/closed state information from the doors. tags: - name: sensor bindings: kafka: clientId: type: string message: $ref: '#/components/messages/DoorData' @lornajane
- 10. $ref Reusable Content Refer to content in the components section message: $ref: '#/components/messages/DoorData' Useful for reuse and readability. We can also refer to other files: message: $ref: 'doors-publish.yaml#/components/messages/DoorData' @lornajane
- 11. Components Section A collection of reusable components components: messages: DoorData: name: door-sensor-data title: Door Sensor Reading description: Door sensor data payload: type: object properties: location: type: string state: enum: ["open", "closed"] @lornajane
- 12. AsyncAPI Loves Standards AsyncAPI is compatible with other standards: • Avro or CloudEvent payload descriptions can be accessed with $ref • JSONSchema is supported • Based on and builds on OpenAPI @lornajane
- 13. AsyncAPI Tools
- 15. Generate Code Also using the generator: ag thingum/doors-publish.yaml @asyncapi/nodejs-template -o thingum/nodejs -p server=development @lornajane
- 16. Tools Landscape • VSCode extension: https://github.com/asyncapi/vs-asyncapi-preview • Validation/linting: https://stoplight.io/open-source/spectral/ • Generate test data: https://microcks.io/ • GitHub action: https://github.com/WaleedAshraf/asyncapi-github-action @lornajane
- 17. AsyncAPI and You Open standards, seamless integrations
- 18. Resources • AsyncAPI: https://asyncapi.com • Aiven: https://aiven.io • Examples: https://github.com/aiven/thingum-industries @lornajane