Tuesday, September 22, 2020

Cument Your Restful API











About:

PLEASE CONTACT ME BEFORE CREATING AN ORDER. THANKS

Catering to a new developer is tricky, especially if an API is not well documented. When they come on board,  they are analytical, precise, and are trying to solve important problems with your API. They want to spend the minimum time understanding your API effectively.  This is where API documentation comes into the picture.

I will document your API so that the third-party developer, who is your API’s main consumer, spends less time understanding the working of the API and more time solving complex programming challenges. I will help make a smooth transition for your developer when discovering, learning to use, and finally integrating with your API.



Templates/tools that I use:
  • Slate - Sample designs https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild
  • Aglio - Sample design https://api.eventyay.com
  • Swagger - Sample design https://petstore.swagger.io
  • Redoc - Sample design https://redocly.github.io/redoc (Requires a running server)
  • GitBook - Sample design https://docs.gitbook.com
  • Readme.io - Sample design https://developer.yammer.com/docs

PLEASE CONTACT ME BEFORE CREATING AN ORDER. THANKS





Reviews


:

Amazing knowledge! Very good communication skills, very skilled!

:

The delivery of work was so smooth. The document created was perfect and I didn't had to change anything.

:

She knows her stuff!

:

Great work

:

She’s very good!




No comments:

Post a Comment