Méthode programmatique pour obtenir tous les points d'API pour mon instance ?

[RGJ (Richard - Communiteq)]

@mcwumbly

Alors, quelles garanties de stabilité pouvons-nous donner concernant notre API backend ?

Je pense que c’est une responsabilité que la documentation de l’API devrait aborder.

Les garanties de stabilité devraient être abordées par un versionnement d’API simple.

@mcwumbly

Premièrement, comme une sorte de modèle mental de haut niveau, je décrirais les choses comme suit :

• Notre point d’entrée principal pour la documentation est ici, comme vous l’avez souligné : Documentation - Discourse Meta
• Pour la documentation développeur, elle est ici, ou peut-être encore mieux, ici : Introduction au développement Discourse
• La documentation de l’API est un sous-ensemble de la documentation développeur, et se trouve ici : https://docs.discourse.org/

J’appellerais la documentation de l’API des docs plutôt que des spécifications, mais je suis d’accord pour dire qu’elle reste un sous-ensemble de notre documentation développeur. L’URL de cette documentation est étrange… il serait plus logique que notre documentation complète y réside ou que ce soit une redirection vers Documentation - Discourse Meta, et qu’il y ait un panneau clair depuis Introduction au développement Discourse vers la documentation de l’API.

Ce sujet ne porte pas sur l’emplacement de la documentation, mais sur la manière dont l’API est documentée. Ce qui manque, c’est un format standardisé et lisible par machine comme OpenAPI.

Cette absence, ainsi que le manque de versionnement, rendent le travail d’intégration plus difficile et plus fragile qu’il ne devrait l’être. Même un schéma OpenAPI de base pour les points d’accès documentés serait très utile.