r/api•
drs997

I built a REST API for generating PDF documents from HTML or templates

I'd like to share my side project that allows you to easily generate PDFs and images.

Would love some feedback on the API documentation that I have just reworked.

Thanks!

Posted Dec 23, 2021, 11:01 AM UTC

197
AndroidTW•

I'm a technical writer at Google, and looked through the first 2/3 of your documentation. EXCELLENT work. I daresay I couldn't do better, myself.

One question that came to mind when reading PDF Example 1 is who the email would say it was coming from?

Also a nit that your hyperlinks are grabbing the space between the final word and the following word. That might be a setting in your docs generation tool.

I'm tucking a link to your tool aside for the next time I'm working on a project that might need to leverage it!

3
drs997OP•

Wow thanks so much for taking the time to check out my documentation and provide this feedback.

Regarding the "from" email address, this takes the authenticated user's email address once they have completed a verification process. I will elaborate this in the docs! Thank you

3
wolfypm•

What have your written your API documentation on? formatting looks great

3
drs997OP•

Hey, I actually rolled my own using tailwind

1
Soopervoo•

Following

1
BatmanMeetJoker•

nice job, can you please explain which tech stack you are using ?

1
Offer_Gombo•

Hey, great work. Add you api to marketplaces like rapidapi and byvalue.org you'll get exposure as well as advice and additional revenue!

0