🙌 Как выглядит идеальная API-документация в Postman для портфолио СА? 🙌

1️⃣ Есть общее описание проекта.

2️⃣ Есть информация о способе авторизации запросов.

3️⃣ Используются переменные окружения — удобно для переключения между средами.

4️⃣ У каждого метода есть описание: что делает, кому доступен, ограничения.

5️⃣ Приведены примеры всех возможных ответов:
и успешных,
и ошибочных.

6️⃣ Примеры JSON-запросов и ответов — реалистичные.

7️⃣ Headers настроены там, где это требуется.

8️⃣ В демо документации показано только 2 метода — для портфолио желательно не менее 10 📌



Образец документации для проекта #MeetsGA в открытом доступе:
📎 https://documenter.getpostman.com/view/20545501/2sB3BANYdP

Метод создания встречи аккуратно перенесён из Confluence.



Все методы оформлены так, как должно быть в идеальном портфолио системного аналитика 🙌

Да и не только в портфолио, а конечно же и в ваши проектах!


🟠 По нажатию на "Run in Postman" вы можете открыть Postman-коллекцию и посмотреть как она была создана.


Сохраняйте и используйте как пример для своих проектов 🤝

#RestApiGA