1.

How do you document an API functionality? What are the tools available for achieving the same?

Answer»

API documentation REPRESENTS any DESCRIPTION of the functionality of the API. Since this documentation will be used by external developers, we need to follow some best practices. They are:

  • Plan what needs to be shown in your documentation.
  • Do not exclude any fundamental sections of the API functionality.
  • Use simple words by AVOIDING technical jargon.
  • Include various interactive examples and resources to UNDERSTAND the API functionality clearly.
  • Consistently maintain the documentation as and when the functionality gets updated.

Some of the popular TOOLS used for achieving API documentation are:

  • JavaDoc
  • Doxygen
  • OpenAPI
  • Redoc
  • Swagger UI


Discussion

No Comment Found

Related InterviewSolutions