Comment trouver la gouvernance des API ?

Lorsque vous choisissez de modifier votre fichier de spécifications, vous trouverez plusieurs vues différentes. L'un d'eux s'appelle Gouvernance. Dans cette vue, vous verrez les résultats d'un audit et pourrez fournir des commentaires pour chaque avertissement ou erreur en fonction des règles que vous avez définies.

À quoi servira la gouvernance des API ?

Voici les points clés des bonnes pratiques API :

• Info: Assurez-vous que chaque API possède des propriétés essentielles telles que le titre, la description et d'autres informations nécessaires.

• Gestion des versions : Imposez l'utilisation d'une version sémantique ou basée sur la date standard pour chaque API.

• Opérations : Assurez-vous que chaque opération individuelle inclut un résumé, une description et un identifiant.

• Paramètres: Standardisez le format des noms de paramètres et assurez-vous que tous les paramètres ont des descriptions appropriées.

• Réponses : Défendez un ensemble commun de codes d'état, de types de médias et de réponses de schéma pour toutes les API.

• Schéma: Standardisez tous les schémas de requête et de réponse à l'aide des composants JSON Schema.

Et après?

Actuellement, nous avons une règle fondamentale nomméeOpenAPI Best Practice. À l'avenir, nous prévoyons d'introduire des ensembles de règles supplémentaires, y compris OWASP Top 10 Security et des ensembles de règles personnalisés. Restez à l'écoute pour ces ajouts à venir.

La gouvernance des API englobe plus que la conception et les normes ; il s'agit de responsabiliser les gens et de maximiser la valeur des API. En utilisant l'automatisation, des ateliers et des sessions de formation, la gouvernance des API aide les utilisateurs à développer des mesures de sécurité, des définitions de produits et des stratégies de mise en œuvre. Pour garantir son efficacité, il est crucial de reconnaître tous les composants et implications de la gouvernance des API. Pour plus d'informations, restez à l'écoute du blog d'Apigit pour les prochains articles sur des sujets essentiels de gouvernance des API.