Esistono strumenti per definire l'API Rest nel documento?

Question

Molte domande vengono poste sulla generazione di Rest API in documenti html.

Ma le uova provengono dal pollo.

In molti casi, l'architettura deve definire l'API. È una connessione tra gli sviluppatori web e gli sviluppatori client iOS/Android.

Così, c'è questo tipo di strumento o web, possiamo seguiamo cose:

Nuova API scrivere la subURL scrivere il metodo POST/GET scrivere i parametri pubblicare scrivere le risposte restituite write la richiesta di campionamento, qualsiasi tipo di condizione, codici di errore. Dopo tutto questo, c'è un documento o un documento online html lì.

Possiamo modificarlo, aggiornarlo dopo che i tempi passano. Lo sviluppatore web/client, solo bisogno di guardare il documento, quindi sono pronti ad andare.

È possibile archiviare questo tipo di strumento? Grazie.

Answer 1

Esistono un paio di specifiche per i documenti che consentono ai client di scoprire API RESTful.

• Swagger (demo)
• apiary
• JSON Home
• Google utilizzare il proprio Discovery Service, però a differenza delle altre, purtroppo, non credo che ci sono le librerie Sourced aperti che consentono di utilizzare esporlo da le tue API.

Ho usato lo swagger e funziona bene. Le specifiche gestisce le cose che hai menzionato:

• JSON uno schema per descrivere richiesta/risposte
• Un elenco di codici di errore/condizioni
• Un codegen library per generare il codice lato client per una serie di linguaggi come JavaScript , Java, Scala, Objectove-C, PHP, Python, Ruby e altro.