arachnys / athenapdf

Drop-in replacement for wkhtmltopdf built on Go, Electron and Docker
MIT License
2.26k stars 186 forks source link

Is there any API documentation? #215

Closed lexicalunit closed 3 years ago

lexicalunit commented 3 years ago

I'm curious about evaluating weaver for our use but I don't see any API documentation. How do I find out what endpoints there are? Basic things like that. Do I just need to read the Go code directly to get that kind of information?

MrSaints commented 3 years ago

Hey there, this is roughly documented in https://github.com/arachnys/athenapdf/blob/dc33a8ac7f06ed6054f847aff291e489f981ec9a/README.md#microservice

See also https://github.com/arachnys/athenapdf/issues/180

Though it is worth mentioning this project is no longer actively maintained. I would suggest using https://github.com/thecodingmachine/gotenberg which takes some inspiration from this project, and provides much clearer docs. Alternatively, if your requirements are simple, you can deploy a "serverless" converter, e.g. https://github.com/Courtsite/shuttlepdf