We help IT Professionals succeed at work.

I need examples of well-written, well-laid out API Documentation

brothertruffle880
brothertruffle880 used Ask the Experts™
on
Can I get a few examples of well-written, well-laid out API documentation.  
I would love it if it were in MS Word format.
Thank you!
Comment
Watch Question

Do more with

Expert Office
EXPERT OFFICE® is a registered trademark of EXPERTS EXCHANGE®
Fractional CTO
Distinguished Expert 2018
Commented:
Simple: Just visit any site providing API services + clone whatever documentation you require.

https://documentation.mailgun.com/en/latest/ - one random API I use daily.
David FavorFractional CTO
Distinguished Expert 2018

Commented:
Note: The search - api documentation - returns 300M results.

Many of these APIs have downloadable PDF versions, if required.

Just pick whichever ones seem useful as starting points for your API design.

Tip: API design is best handled by someone who has written many API systems, as the API backend dev work is different than most other Application or Website coding. How your backend dev is arranged will drive your public facing API alls. Designing API calls before designing the API backend generally leads to an API that fails. I've seen this design mistake occur many times.
Chinmay PatelChief Technology Ninja
Distinguished Expert 2018
Commented:
Hi there,

As you have mentioned .Net Programming too, I could not help but suggest couple of Microsoft assets.
1. https://docs.microsoft.com/ - Generic Starting point - All Microsoft documentation is available here.
2. https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/overview - Common Data Service Web Api documentation
3. https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/about?view=dynamics-ce-odata-9 - Dynamics 365 Customer Engagement API documentation

All Microsoft Docs are exportable so you don't have to export individual pages, you can start at the first page and export entire thing to PDF (and then using Microsoft Word, you can convert the PDF To Microsoft Word document).

Regards,
Chinmay.
Joe WinogradDeveloper
Fellow 2017
Most Valuable Expert 2018
Commented:
Here are three APIs/SDKs that I've used:

(1) Acrobat DC SDK
Note the JavaScript for Acrobat API Reference in that download.

(2) This is a nice example of an online one:
https://www.inliteresearch.com/help/ClearImage.90/webframe.html#Introduction%20to%20ClearImage%209.html

(3) Another good online one:
https://dev.docparser.com/#getting-started

All meet your "well-written, well-laid out API documentation" criteria, imo, but none is in Word. Regards, Joe
Scott FellDeveloper & EE Moderator
Fellow 2018
Most Valuable Expert 2013
Commented:
API's are not created equal.  Some have documentation that is automatically generated by the classes used. It takes some digging to get started. Others are well documented.  My examples are

https://developer.authorize.net/api/reference/

As you dive in, you will see not only is this an api, but they also provide SDK's with excellent documentation.  What helps make this easy is the additional SDK's offered.   You have great examples in the main languages https://developer.authorize.net/api/reference/

Paypal does the same https://developer.paypal.com/docs/api/reference/api-requests/ but the authorize.net is easier for most people to read.

Compare to homeaway https://www.homeaway.com/platform/developer-api.  It is better than it was, but as you will see, not as easy to understand as the first two examples https://www.homeaway.com/platform/developer-api  For somebody experienced it is ok, but for somebody new to programming can be difficult.

I don't know that you will find an ms word format because there is just too much information.  The documentation I have had to use in word format always scared me because it meant minimal information.
Shaun VermaakSenior Consultant
Awarded 2017
Distinguished Expert 2018
Commented:
This is swagger example
https://petstore.swagger.io/