I’m looking for a way to get a definitive list of the API endpoints available in my Discourse instance. It can sometimes be difficult to know what APIs are available to me when looking to build an integration into the platform.

[圖片] jordan-violet: I’m looking for a way to get a definitive list of the API endpoints available in my Discourse instance. I don’t think that’s technically possible. Discourse doesn’t have an API discovery route (for example, something similar to the WordPress /wp-json route). The closest th…

Appreciate the response, Simon! I’m familiar with docs.discourse.org (which funny enough aren’t the official docs but the API specs). I’m also familiar with using my browser console to capture requests as well as perusing through routes.rb files. As you can imagine though—the two options above are…

The definitive source, other than the source is to Reverse engineer the Discourse API . Everything that you can do on the front end you can do with the API. There are a very few things that you can do only with the API.

[圖片] jordan-violet: I’m familiar with docs.discourse.org (which funny enough aren’t the official docs but the API specs) Can you clarify what you mean by this a bit more? While Simon’s point about these not covering APIs that are implemented by extensions to Discourse (e.g. plugins), these d…

Sure! This is probably more than you asked for :smiley: I think you keep your official product documentation here, correct? Documentation Official documentation for how to use Discourse, install and configure sites, develop plug…

OK, I think I understand better, thank you. What follows are my own opinions – I haven’t run these by people more knowledgeable than myself, so I may get corrected on a few things that I’m getting wrong here. Our story documentation is also evolving. We’ve made significant strides, but there’s a l…

[圖片] mcwumbly: So what stability guarantees can we be making about our backend API? I think that’s a responsibility those API docs should be addressing. Stability guarantees should be addressed by straightforward API versioning. [圖片] mcwumbly: First, as a kind of higher level mental mod…

Fundamentally this is not a documentation problem, it is a implementation problem. @avdi raised this years ago and there is broad internal consensus that the correct path forward is a proper versioned JSON/REST API with consistent params and shapes for data. Currently, the API we ship is our inte…

I think it’s completely reasonable that the change will take time. I ran Developer Relations at my last company and my goodness…it took over two years to get our APIs into an improved state. So many complex things to consider (and engineering hated the idea of making a stable endpoint that couldn’t …

[圖片] RGJ: What’s missing is a standardized, machine-readable format like OpenAPI The api docs are in the OpenAPI format? [CleanShot 2025-04-24 at 12.47.43@2x] https://docs.discourse.org/openapi.json { "openapi": "3.1.0", "info": { "title": "Discourse API Documentation", "x-log…

获取我实例所有API端点的编程方式？

开发

pfaffman (Jay Pfaffman) 2025年四月21日 17:45 5

最终的来源，除了来源本身，就是逆向工程 Discourse API。

您可以在前端完成的所有操作都可以通过 API 完成。只有极少数操作只能通过 API 完成。

話題		回覆	觀看
Discourse API Documentation Released! Blog	2	4181	2017年三月8日
What is the Timing of Formal Discourse REST API? Feature	5	2491	2014年十一月20日
Why isn't the Discourse API fully documented? Development	9	2375	2020年一月13日
Reverse engineer the Discourse API Integrations rest-api , how-to	0	38140	2014年九月29日
Are Post Voting votes/replies accessible via API? Development rest-api , post-voting	2	468	2024年二月25日

获取我实例所有API端点的编程方式？

相關主題