Looking for dev opinions - API description options
Hi all,
We are experimenting with ways to better describe the utility APIs that we building and publishing. Please note that the audience is developers, so i am looking for their feedback. I kind of like the 2nd option , just not sure how it comes across to developers.
Example: An API that generates a QR code
About (1st option)
The Generate QR Code API saves you the hassle of writing extra lines of code and allows you to create QR codes within seconds that can be easily integrated with your applications. The API can convert plain text or links into a QR code PNG file and customizes the output as a downloadable PNG as well as a URL pointing to the newly created PNG file that can be shared with your target audience.
About (2nd option)
Hello! I am Apyhub's Generate QR Code API.
I exist to save you the hassle of writing extra lines of code to produce QR codes. Push me to generate dynamic QR codes for your applications within seconds.
All I need is the text you wish to display or a link if you prefer to whatever you want your QR code to point to and I return a brand new personalized QR code as an output.
What's more? You can choose how you want me to customize the outputs. I can produce PNGs and can also give you URLs.
I am pretty easy to use, but feel free to read on to know more about the very few parameters I need to be customized to your requirements.
Thanks!
As a developper, I don't see the point to add a dependency to an external api to just generate qr codes. Qr code generation libraries exist in a lot of languages. Who is your target audience ? I think you need to be a dev to use an api so you have already the required programming knowledge to write the 5 lines it takes to install and import a library. It's not like if everyone had to read Denso documents.