Ho familiarità con lo stack Microsoft. Sto usando OData per alcuni dei miei servizi di riposo. Recentemente mi sono imbattuto in Swagger per la documentazione dell'API e sto cercando di capire come si rapporta a OData. Entrambi sembrano essere specifiche RESTful. Quale è ampiamente usato?Cos'è Swagger e si riferisce a OData?
Swagger è una specifica per API di documentazione. Creando un documento di swagger per la tua API, puoi passarlo a un'istanza dell'interfaccia utente di Swagger, che esegue il rendering del documento in un formato ordinato e leggibile e fornisce strumenti per richiamare le tue API. Vedere il sito Web swagger.io per ulteriori informazioni.
OData è una specifica per la creazione di servizi dati su HTTP, si definisce come un servizio deve essere costruito e quali modelli si dovrebbe seguire. Ad esempio, l'uso della direttiva $ top per fornire i primi n risultati di un set di dati. OData è attualmente alla versione 4, ma la documentazione di v2 ha un very good overview.
Swashbuckle is a nuget package per Microsoft stack che produce documenti spavalderia per il vostro API automaticamente, sulla base di ispezionare il codice e metadati aggiuntivi che fornisci a plasmare il documento di output.
Se si desidera Swashbuckle per generare automaticamente i documenti spavalderia di un'API OData si sta creando, quindi è possibile utilizzare Swashbuckle.OData di fornire questo per voi.
Spero che questo aiuti a chiarire ogni confusione.