Plugin API documentations?

[a9udn9u]

Sorry if this has been asked, I tried searching for documentations but all I can find is the Get Started post, it helped me create a plugin but it didn’t cover topics such as what APIs are available. So, are there documents at all?

Thanks!

[net_deamon]

Api documentation is available at
http://docs.discourse.org

[a9udn9u]

Discourse API doc is not what I’m requesting. I was thinking about something like Chrome plugin development docs or WordPress plugin development docs. For example when I read the Beginner’s Guide to Creating Discourse Plugins, I have questions like what are other special properties and callbacks does Discourse recognize in the default module? or what parameters are passed into the initialize() method? Neither the guide nor docs.discourse.org answered those questions.

[net_deamon]

As discourse uses ember in frontend and rails in backend, you can browse their respective docs to know how to create components, or controllers, etc.

That being said, you can go through the code of discourse to learn how they are doing things.

I had asked similar question long time back… See if the answers given here help you.

How do you learn to build Discourse plugins?

How do you guys build such amazing plugins with discourse ? I am not even able to integrate a custom field to discourse topic using a custom plugin. Is there any documentation that can help me build an advanced plugin like this? The introduction series to Discourse plugins only touches the plugin outlet part. But how do I take that and integrate it with Discourse? I tried reading the source code of Discourse plugins, as Jeff suggested, But I only have questions like what does add_to_serializer …

[erlend_sh (Erlend Sogge Heggen)]

@a9udn9u

I have questions like what are other special properties and callbacks does Discourse recognize in the default module? or what parameters are passed into the initialize() method? Neither the guide nor docs.discourse.org answered those questions.

Then those questions are probably good candidates for dev

[bcartwri96 (Ben Cartwright)]

Ich hebe das nochmal an, da es noch nicht beantwortet wurde

[pacharanero (Marcus Baw)]

@bcartwri96 Ich denke, das Fazit ist, dass es nur sehr wenig umfassende Dokumentation für die Plugin-API von Discourse gibt.

Es gibt hier und da einige Informationen auf Meta, wie zum Beispiel unter Developing Discourse Plugins - Part 1 - Create a basic plugin, aber es scheint keine vollständige API-Referenz zu geben. Obwohl ein Teil davon reines Ember oder Rails ist, gibt es eine enorme Menge dazwischen, die reine Discourse-Konventionen sind.

Im Laufe der Zeit wäre es gut, wenn die Community an einem Discourse-Entwicklerhandbuch arbeiten könnte, das diese Lücke schließen würde. Wir haben bereits einige Fragmente von HOWTOs unter Pavilion umgesetzt und hoffen, dass diese Arbeit eine gute Grundlage für die Entwicklung eines umfassenderen Referenzleitfadens bildet.

[fzngagan (Faizaan Gagan)]

Schau dir diese Datei an. Die meisten Methoden sind kurz dokumentiert
https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/app/lib/plugin-api.js

[alxndr (Alexander)]

Diese Datei wurde nach blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs verschoben