templates - sono - web service rest crud




Esempio di un servizio RESTful ben documentato (5)

Devo scrivere la documentazione di un servizio RESTful. Qualcuno sa di una documentazione molto ben scritta per un servizio RESTful che potrei usare come modello per il mio?

Grazie.


È possibile consultare la documentazione dell'API di Zoho Subscriptions . Questo documento di layout a 3 colonne è strutturato in base alle risorse e presenta richieste e risposte di esempio per ogni endpoint.

Divulgazione: faccio parte del team di abbonamenti Zoho.


Hai sentito parlare di http://swagger.io/ ? Genera una documentazione molto utile (e piacevole) per un'API REST.

Provaci. Lo consiglio davvero.


L' API di leggibilità è stata recentemente lodata su Twitter.

Divulgazione: sono un parter di Arc90, i creatori di Readability e un investitore in Readability.



Prova lo rest-tool .

Segue un approccio agnostico alla scrittura delle specifiche. Fornisce un'implementazione simulata istantanea e test unitari automatizzati per le API RESTful off the shelf.

I servizi sono specificati tramite i file YAML e i dati di esempio possono essere posizionati accanto ai descrittori. È possibile trovare uno schema JSON aboultare il formato del file descrittore service.yml. Questo può essere usato come una gilda, ma è estendibile su richiesta.





documentation