where's the lua API documentation for plugin developer

[caibirdme]

I'm trying to learn to develop apisix plugin in lua, and I see the examples in documentation.
But in that example, it import lua lib, like:

local core = require("apisix.core")
local router = require("apisix.router")
local ngx = ngx
-- ...

But I don't know what APIs these lib provide, and I can't find docs. The only way is to look into the source code?

[tzssangglass]

Yes, reading the source code is the best way. See also other plugins code.

[juzhiyuan]

Ya, and I remember there has one rule called don't make me think 😄

[caibirdme]

Thx, and I'm doing so. But I still hope that apisix can provide more detailed docs for plugin development. If I don't have a detailed api docs, I don't know if I could implement some features, thus one will be hesitate about investing time into apisix

[juzhiyuan]

Agree with you, and the community needs more contributions from contributors. If you have time, I sincerely invite you and more members to join Apache APISIX's community :)

[caibirdme]

When I'm reading about the source code, I'll try 2 make some docs. Is there any api doc format or so, that openresty or apisix is using

[tzssangglass]

just like:https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#methods

It would be good to have an example of how to use it.