Perché dobbiamo dichiarare un'API pubblica quando si utilizza il controllo delle versioni semantico?

Naviga le tue risposte
2

da semver.org:

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it should be precise and comprehensive.

Perché siamo costretti a dichiarare un'API pubblica? Perché non posso usarlo per il mio sito web che non ha API?

Forse ho sbagliato con la definizione. Per me è una parte del sito desigedn per altri sviluppatori (es .: api.example.com ) che consente loro di interrogare il mio sito Web e ottenere il risultato in dati strutturati (json, xml ...).

    
posta Vinz243 14.05.2014 - 21:35
fonte

1 risposta

8

Richiede un'API pubblica per applicare efficacemente il suo modello di versione.

Ad esempio:

Bug fixes not affecting the API increment the patch version

Backwards compatible API additions/changes increment the minor version, and...

Backwards incompatible API changes increment the major version.

Ciò che rappresenta la tua API è soggettiva, come dichiarano persino nel documento SemVer:

This may consist of documentation or be enforced by the code itself.

Penso che sia il tuo malinteso. Un'API non è necessariamente ...

a part of the site designed for other developers that allow them to query my website and get the result into structured data

Potrebbe essere quello. Chissà. Potrebbe anche essere un insieme di regole UX documentate.

Se non riesci a delineare in modo efficace l'API del tuo sito web, allora forse SemVer non è appropriato.

    
risposta data 14.05.2014 - 21:39
fonte

Leggi altre domande sui tag

Equazione di più variabili nuove con una vecchia È meglio disegnare la mia grafica o importare immagini?