API interna all'API pubblica - controllo delle versioni

0

Abbiamo un'API interna specifica per il nostro sito Web e le applicazioni interne e stiamo pianificando di rilasciare un'API pubblica che esponga alcuni endpoint nella nostra API interna.

Usiamo il versioning semantico e la nostra API interna è alla versione 6, avrebbe senso solo creare un nuovo progetto e iniziare dalla versione 1?

    
posta Hank 21.11.2015 - 01:48
fonte

1 risposta

3

Dato che hai detto "alcuni" degli endpoint, significa che l'API interna e l'API pubblica sono già interfacce significativamente diverse, oltre ad avere basi utente completamente diverse. Pertanto, è del tutto possibile che si possa aver bisogno di cambiare in modi che non dovrebbero avere alcun effetto sull'altro. Quindi , ha perfettamente senso utilizzare numeri di versione separati per ciascuna API.

Assicurati solo che il modo in cui esponi questi endpoint sia sufficientemente flessibile da consentire di apportare modifiche all'API pubblica o all'API interna senza influire sull'altro, se lo desideri. E dovresti avere due "dichiarazioni API pubbliche" completamente distinte (indipendentemente dal significato di file di intestazione o documentazione API o qualcos'altro per il tuo progetto).

    
risposta data 21.11.2015 - 02:43
fonte

Leggi altre domande sui tag