RAML
RESTful API Modeling Language (RAML) è un linguaggio basato su YAML che descrive le API RESTful. RAML offre inoltre funzionalità che consentono di documentare in modo esaustivo un'API RESTful, abilitare strumenti per la generazione di documentazione per estrarre la documentazione dell'utente e quindi tradurla in formati visivi quali PDF, HTML e così via.
Usare l'azione RAML per accedere alle API ed effettuare chiamate API ai servizi per cui le API vengono create utilizzando RAML. L'azione RAML supporta la versione 0.8 della specifica RAML.
Per utilizzare l'azione RAML nel workflow, attenersi alla procedura descritta di seguito.
1. Fare clic su e trascinare l'azione RAML presente in Progettazione API nell'area di lavoro, posizionare il puntatore del mouse sull'azione, quindi fare clic su o fare doppio clic sull'azione. Viene visualizzata la finestra RAML.
2. Se necessario, modificare l'Etichetta. Per default, il nome dell'etichetta corrisponde al nome dell'azione.
3. Nel campo URL file radice immettere l'URL per recuperare il file zip contenente il file RAML radice e le rispettive dipendenze.
4. Nel campo Nome file radice immettere il nome del file radice RAML da recuperare.
5. Fare clic su Recupera per recuperare tutte le API definite nel file RAML.
L'elenco Richiesta API fornisce un elenco di API definite nel file RAML.
6. Nell'elenco Richiesta API selezionare un'API.
A seconda dell'API selezionata potrebbe essere necessario immettere ulteriori dettagli.
7. Fare clic su Fine.
Schema di output
È stato utile?