API-documentation.md

What is API Documentation?

A manual with detailed instructions on how to integrate or use an API, for third-party developers. This include

• Query parameters
• Response objects
• Code samples

Why document APIs?

• Less work on customer support
• Increased direct reach to consumers
• Easy to update

What needs to be tested on APIs?

• Expected response code from a successful request
• Expected response code from an unsuccessful request
• Fields to be validated
• Parameters required
• Error handling of unsuccessful requests
• HTTP verbs that we can use with the endpoints

How to test an API functionalty?

• Validation testing
• Functional testing
• UI testing
• Load testing
• Error detection
• API security test
• Integration testing
• Reliability testing