¿Forma programática de obtener todos los endpoints de API para mi instancia?

[RGJ (Richard - Communiteq)]

@mcwumbly

Entonces, ¿qué garantías de estabilidad podemos hacer sobre nuestra API de backend?

Creo que esa es una responsabilidad que la documentación de la API debería abordar.

Las garantías de estabilidad deben abordarse mediante un control de versiones de API sencillo.

@mcwumbly

Primero, como una especie de modelo mental de alto nivel, describiría las cosas de esta manera:

• Nuestro punto de entrada principal para la documentación está aquí, como señalaste: Documentation - Discourse Meta
• Para la documentación del desarrollador, está aquí, o quizás mejor aún, aquí: Introduction to Discourse Development
• La documentación de la API es un subconjunto de la documentación del desarrollador y se encuentra aquí: https://docs.discourse.org/

Llamaría a la documentación de la API documentación en lugar de especificaciones, pero estoy de acuerdo en que sigue siendo un subconjunto de nuestra documentación para desarrolladores. La URL de esa documentación es extraña… tendría más sentido que nuestra documentación completa residiera allí o que fuera una redirección a Documentation - Discourse Meta, y que hubiera una señal clara desde Introduction to Discourse Development a la documentación de la API.

Este tema no trata de dónde vive la documentación, sino de cómo se documenta la API. Lo que falta es un formato estandarizado y legible por máquina como OpenAPI.

Esa ausencia, junto con la falta de control de versiones, hace que el trabajo de integración sea más difícil y frágil de lo que debería ser. Incluso un esquema OpenAPI básico para los puntos finales documentados sería de gran ayuda.