Εισαγωγή ενός εγγράφου AsyncAPI

Το AsyncAPI περιγράφει τα API που οδηγούνται από συμβάντα όπως το OpenAPI περιγράφει τα API REST. Το Restorm βγάζει από αυτό αιτήματα ανταλλαγής μηνυμάτων.

Εισαγωγή

Αρχείο ▸ Εισαγωγή (Ctrl+I) και έπειτα το έγγραφο, σε YAML ή σε JSON.

Τι εισάγεται

Στοιχείο	Τι κάνει το Restorm με αυτό
Κάθε κανάλι	Ένα αίτημα δημοσίευσης και ένα αίτημα εγγραφής, με ανάλογη σήμανση
Το πρωτόκολλο του διακομιστή	Τον τύπο του αιτήματος που παράγεται (δείτε παρακάτω)
Το σχήμα των μηνυμάτων	Ένα δείγμα ωφέλιμου φορτίου κατασκευασμένο σύμφωνα με το σχήμα
Περιγραφές	Την τεκμηρίωση API

Τα αιτήματα ομαδοποιούνται σε έναν φάκελο ανά πρωτόκολλο.

Αντιστοιχία των πρωτοκόλλων

Πρωτόκολλο AsyncAPI	Αίτημα Restorm που παράγεται
mqtt, mqtts	MQTT, με πρόθεμα URL mqtt://
socketio, socket.io	Socket.IO
Όλα τα υπόλοιπα	WebSocket, με πρόθεμα URL ws://

Kafka και AMQP

Οι συνδέσεις AsyncAPI Kafka και AMQP δεν παράγουν αιτήματα Kafka ή AMQP: εμπίπτουν στην κατηγορία «όλα τα υπόλοιπα» και δίνουν αιτήματα WebSocket. Δημιουργήστε αυτά τα αιτήματα στο χέρι μετά την εισαγωγή — η δομή των καναλιών που εισήχθη σας δίνει τα θέματα και τις ουρές που πρέπει να χρησιμοποιήσετε.

Ενημέρωση

Το AsyncAPI ανήκει στις επανασυγχρονίσιμες μορφές. Δείτε Ενημέρωση από την πηγή.