listmonk icon indicating copy to clipboard operation
listmonk copied to clipboard

Published 20 hours ago • verified publisher icon knadh

Provide swagger for API

Open jirisykora83 opened this issue 2 years ago • 4 comments

It will be nice to have swagger which seems like most commonly use documentation for api which enables auto generating api client.

jirisykora83 avatar Mar 30 '22 20:03 jirisykora83

You mean OpenApi, don't you? Swagger is just a tool.

NicoHood avatar Mar 31 '22 06:03 NicoHood

yes, I mean OpenApi :) in best case provided as swagger.json

jirisykora83 avatar Mar 31 '22 13:03 jirisykora83

When this is done, I'd love to create an integration / node on n8n based on ListMonk's API which I feel would supercharge the functionality of the tool

christianechevarria avatar Jul 06 '22 19:07 christianechevarria

This task is up for grabs, if anyone's interested in working on it!

knadh avatar Jul 07 '22 03:07 knadh

@knadh So if I am getting this correct, we need to create a swagger collection of all listmonk APIs. If yes then, I can take up this issue. Thanks

rohansh-tty avatar Mar 01 '23 18:03 rohansh-tty

@rohansh-tty. Yes, that would be nice. Thanks.

knadh avatar Mar 02 '23 06:03 knadh

@rohansh-tty why don't you send a PR with the work you've done so far? I'm planning to merge the contents of the listmonk-site repo into a docs directory on this repo. You can put the Swagger specs in docs/swagger and send a PR.

knadh avatar Mar 22 '23 11:03 knadh

@knadh Based on my current progress, I have created a PR. There are a couple of endpoints that I need to add from my end. And I'll be updating the collection this weekend. Please let me know if any changes are required.

rohansh-tty avatar Mar 22 '23 18:03 rohansh-tty

@rohansh-tty's PR is merged. Thanks! https://github.com/knadh/listmonk/tree/master/docs/swagger

knadh avatar Mar 26 '23 05:03 knadh

@rohansh-tty the Swagger site is up. Documented here: https://listmonk.app/docs/apis/apis/

knadh avatar Apr 12 '23 06:04 knadh