Esiste uno standard per le descrizioni leggibili dalla macchina dei servizi RESTful?

Question

Esiste uno standard per le descrizioni leggibili dalla macchina dei servizi RESTful?

#1 da (2 voti)

5

Ho interagito con alcune API RESTful che hanno fornito un'eccellente documentazione per gli umani e gli URI descrittivi, ma nessuno di loro sembra restituire descrizioni auto-leggibili di se stessi.

Non è troppo difficile scrivere metodi per assemblare i percorsi giusti, e molte librerie API specifiche della lingua sono già solo wrapper attorno a richieste RESTful. Ma il prossimo livello di astrazione sembra davvero utile: una libreria in grado di leggere nella documentazione leggibile da una macchina API e generare automaticamente i wrapper, magari con una chiamata ad alcuni URI standard come base_url + '/documentation'

Esistono standard per la documentazione dell'API leggibile dalla macchina? Sto facendo REST sbagliato? Sono un programmatore relativamente nuovo, ma mi sembra una buona idea.

api design-patterns rest abstraction libraries

posta ecmendenhall 18.09.2012 - 03:27

fonte

1 risposta

Leggi altre domande sui tag api design-patterns rest abstraction libraries

Editor di notazione musicale: rifattorizzazione della logica di creazione di viste altrove Utilizzo di div in stile tabella anziché tabelle

score 2 · Accepted Answer

Sì, ci sono diversi modi che è possibile utilizzare.

Uno di questi è generare il codice, i test e la documentazione del client usando una serie di strumenti che supportano WADL. Alcuni esempi possono essere trovati in questo post del blog .

Potrebbe anche essere preferibile utilizzare WADL, piuttosto che WSDL 2.0 perché è meno dettagliato e molto più semplice (IMHO). Infatti, usando WADL si descrive esattamente ciò che l'utente vede nella pagina della documentazione, usando solo la sintassi WADL XML. Ed è anche uno dei motivi per cui è così facile scrivere generatori di documentazione basati su XSLT per WADL.