Your REST API consumers need to understand your

REST API:

Resources

Actions

Request/Response Structure (Constraints/Validations)

Challenges:

Accuracy: How do you ensure that your documentation is upto

date and correct?

Consistency: You might have 100s of REST API in an enterprise.

How do you ensure consistency?

Options:

1: Manually Maintain Documentation

Additional eff ort to keep it in sync with code

2: Generate from code