AsyncAPI 101

Transcript

1. AsyncAPI 101 Daniel Kocot, Senior Solution Architect / Head of API Experience & Operations
2. Name: Daniel Kocot Role: Senior Solution Architect / Head of API Experience & Operations Email: Twitter: @dk_1977 LinkedIn: daniel.kocot@codecentric.de https://www.linkedin.com/in/danielkocot/
3. Goal / Idea: Documenting Event- and Message- Driven Architectures
4. Protocols AMQP AMQP 1.0 HTTP IBM MQ JMS Kafka MQTT MQTT5 NATS Redis SNS Solace SQS STOMP WebSockets
5. Protocols condensed AMQP AMQP 1.0 Kafka MQTT MQTT5
6. Events vs. Messages Reactive Manifesto in event-driven architecture the consumer decide to whom to they subscribe in message-driven architecture the consumer are known by the producer
7. OpenAPI / AsyncAPI
8. Id, Tags & External Docs Object
9. Example Id Object asyncapi: '2.4.0' id: 'urn:de:codecentric:asyncapidemo:orderservice'
10. Info & Servers Object
11. Example Info & Servers Object info: title: Order Service version: 1.0.0 description: The service is in charge of processing orders contact: name: Daniel Kocot email: daniel.kocot@codecentric.de license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: server: $ref: '#/components/servers/rabbitmq' channels: orderProcessed:
12. Channel Object
13. Example Channel Object servers: - server publish: operationId: orderProcessedPub description: Payload of processed order message: $ref: '#/components/messages/orderProcessed' bindings: $ref: '#/components/messageBindings/amqp/bindings' subscribe: operationId: orderProcessedSub description: Payload of processed order message: $ref: '#/components/messages/orderProcessed' bindings: $ref: '#/components/messageBindings/amqp/bindings' bindings: amqp: $ref: '#/components/channelBindings/amqp' components: schemas:
14. Components Object
15. Example Components Object OrderPayload: type: object properties: id: type: integer format: int64 description: ID of received order customerReference: type: string description: Reference for the customer according the order servers: rabbitmq: url: "{stage}.codecentric.de:{port}" description: RabbitMQ Broker protocol: amqp protocolVersion: '0.9.1' variables: stage: enum: [qa, prod] default: qa port: enum: ['5672', '15672'] default: '5672' serverVariables:
16. Binding Objects Server Channel Operation Message depending on the implementation of a binding
17. Kafka Operation Binding Object channels: user-signedup: publish: bindings: kafka: groupId: type: string enum: ['myGroupId'] clientId: type: string enum: ['myClientId'] bindingVersion: '0.1.0'
18. Kafka Message Binding Object channels: test: publish: message: bindings: kafka: key: type: string enum: ['myKey'] bindingVersion: '0.1.0'
19. MQTT Server Binding Object servers: production: bindings: mqtt: clientId: guest cleanSession: true lastWill: topic: /last-wills qos: 2 message: Guest gone offline. retain: false keepAlive: 60 bindingVersion: 0.1.0
20. MQTT Operation Binding Object channels: user/signup: publish: bindings: mqtt: qos: 2 retain: true bindingVersion: 0.1.0
21. MQTT Message Binding Object channels: user/signup: publish: message: bindings: mqtt: bindingVersion: 0.1.0
22. MQTT 5 Binding Objects not implemented for now
23. Message Object a message object must have payload payload can inline or referenced by an external file relying on the schema format provided support formats: Avro 1.9.0 schema OpenAPI 3.0.0 schema object RAML 1.0 data type Custom message parser
24. Tools
25. AsyncAPI Studio
26. AsyncAPI Generator api-showcases/async on  main [?] on ☁️ ➜ ag order-service.yaml @asyncapi/html-template Done! ✨ Check out your shiny new generated files at /Users/danielkocot/api-showcases/async.
27. AsyncAPI generated documentation
28. AsyncAPI CLI All in one CLI for all AsyncAPI tools USAGE $ asyncapi [COMMAND] COMMANDS config access configs diff find diff between two asyncapi files new creates a new asyncapi file start starts a new local instance of Studio validate validate asyncapi file
29. Modelina Generate data models for your payload npm install @asyncapi/modelina import { GoGenerator } from '@asyncapi/modelina'; const generator = new GoGenerator() // const input = ...AsyncAPI document const models = await generator.generate(input)
30. Community
31. Wrap Up Posts on codecentric blog: https://blog.codecentric.de/en/author/daniel-kocot/
32. Q&A
33. Thank you