quirrel icon indicating copy to clipboard operation
quirrel copied to clipboard

List of API Routes

Open ethndotsh opened this issue 2 years ago • 3 comments

I would like to use Quirrel, but I'm not using a JS Backend (I plan to use Go). I know you aren't working on Quirrel anymore, but a swagger doc or a list of all api routes and their use would be incredibly useful for using Quirrel with my backend.

ethndotsh avatar Jun 20 '22 02:06 ethndotsh

Hi @cursecodes! Quirrel is being maintained, we're just not developing a lot of new features :D

Every Quirrel instance serves an OpenAPI Doc, here's an example for api.quirrel.dev: https://api.quirrel.dev/documentation/static/index.html If you setup your own instance, you should also be able to access that.

You can use the client part of the codebase as a reference for your Go client: https://github.com/quirrel-dev/quirrel/tree/main/src/client

Skn0tt avatar Jun 20 '22 13:06 Skn0tt

Oh great! Thanks so much,

One other question I have is that for the endpoint parameter, do I just send a complete URL/webhook to call when the event is fired?

ethndotsh avatar Jun 20 '22 13:06 ethndotsh

Yes!

Skn0tt avatar Jun 21 '22 13:06 Skn0tt