What is the best method to create custom APIs on the discourse forum. Eg: I want to create a get request which gives me users.count, topics.count, categories.count How do I add this API into forum ?

You need to write a plugin. See Beginner’s Guide to Creating Discourse Plugins Part 1: Creating a basic plugin

/admin/about.json Has most of that, I think. Or maybe it’s just /about.json.

Not exactly the same data, so I want to create custom JSON API.

I’ve been using GitHub - discourse/discourse-subscriptions: A Discourse plugin that allows payments and subscription management via Stripe. · GitHub as a model for adding a model (you don’t need a full model, but discourse-subscriptions/config/routes.rb at main · discourse/discourse-subscriptions · GitHub gives you an example of how to add a route. That and add_to_class is most of what you need to know. Good luck!

Thanks @pfaffman Will look into it.

I was unable to create a custom page/API through plugin. Is there a beginner’s guide which I could follow ?? or any article that shows the basic steps. I have followed discourse guide and was able to add settings to plugin but was unable to create a new page. @pfaffman

I used the subscriptions plugin as a guide for one that I made. The plugin generator will generate a plugin with a new route. It’s complicated because you have both the rails and ember pieces to wrangle. If you want to add just a rails (api) route then it’s not too hard. (others might say that adding just an ember route is easy). Do you need a new page to render in the browser or just the back end?

Criar APIs Personalizadas

Dev

Falco (Falco) 22 Março , 2021 15:37 2

Você precisa escrever um plugin. Consulte Guia para Iniciantes na Criação de Plugins do Discourse Parte 1: Criando um plugin básico

Tópico		Respostas	Vistas
Can I use the JSON API instead of building a plugin? Development	3	1118	6 Junho , 2020
Call Discourse routes from inside the plugin (Ruby API) Development	0	565	9 Junho , 2020
Plugin API documentations? Development	8	6929	31 Março , 2024
Plugin development without a reference Development	1	615	5 Novembro , 2022
How can i create a topic with content via the Discourse API? Development	2	711	6 Novembro , 2018

Criar APIs Personalizadas

Related topics