Come trovare la governance delle API?

Quando scegli di modificare il tuo file delle specifiche, troverai diverse viste. Uno di questi si chiama Governance. In questa vista, vedrai i risultati di un controllo e sarai in grado di fornire commenti per ogni avviso o errore in base alle regole che hai impostato.

Cosa aiuterà la governance delle API a fare?

Ecco i punti chiave per le best practice API:

• Informazioni: Assicurati che ogni API abbia proprietà essenziali come titolo, descrizione e altre informazioni necessarie.

• Versione: Imponi l'uso del controllo delle versioni semantico o basato sulla data standard per ogni API.

• Operazioni: Assicurati che ogni singola operazione includa un riepilogo, una descrizione e un ID.

• Parametri: Standardizza il formato dei nomi dei parametri e assicurati che tutti i parametri abbiano descrizioni appropriate.

• Risposte: Sostenere un set comune di codici di stato, tipi di media e risposte dello schema tra le API.

• Schema: Standardizza tutti gli schemi di richiesta e risposta utilizzando i componenti dello schema JSON.

Qual è il prossimo?

Attualmente, abbiamo una regola fondamentale denominataOpenAPI Best Practice. In futuro, prevediamo di introdurre set di regole aggiuntivi, tra cui OWASP Top 10 Security e set di regole personalizzate. Resta sintonizzato per queste prossime aggiunte.

La governance delle API va oltre il semplice design e gli standard; ruota attorno all'empowerment delle persone e alla massimizzazione del valore delle API. Utilizzando automazione, workshop e sessioni di formazione, la governance delle API aiuta gli utenti a sviluppare misure di sicurezza, definizioni di prodotti e strategie di implementazione. Per garantirne l'efficacia, è fondamentale riconoscere tutti i componenti e le implicazioni della governance delle API. Per ulteriori indicazioni, resta sintonizzato sul blog di Apigit per i prossimi post sugli argomenti essenziali della governance delle API.