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)]

Je remonte ce sujet car il n’a pas reçu de réponse

[pacharanero (Marcus Baw)]

@bcartwri96 Je pense que, en résumé, il existe très peu de documentation complète sur l’API des plugins de Discourse.

On trouve des éléments d’information ici sur Meta, comme Developing Discourse Plugins - Part 1 - Create a basic plugin, mais il semble qu’il n’existe aucune référence API exhaustive. Bien que certaines parties relèvent simplement d’Ember ou de Rails, il y a une énorme quantité de choses intermédiaires qui sont de pures conventions Discourse.

À terme, il serait souhaitable que la communauté puisse travailler sur un Manuel du développeur Discourse pour combler ce vide. Nous avons déjà mis cela en pratique sous forme de fragments de guides pratiques sur Pavilion, et espérons que ce travail constitue les fondations initiales pour élaborer un guide de référence plus complet.

[fzngagan (Faizaan Gagan)]

Consultez ce fichier. La plupart des méthodes sont brièvement documentées
https://github.com/discourse/discourse/blob/master/app/assets/javascripts/discourse/app/lib/plugin-api.js

[alxndr (Alexander)]

Ce fichier a été déplacé vers blob/main/app/assets/javascripts/discourse/app/lib/plugin-api.gjs