Сеть публичных API Postman известна тем, что содержит более 120 000 коллекций, в которых представлены крупнейшие бренды планеты. И хотя большинство коллекций существует для того, чтобы облегчить разработчикам доступ к публичным API, опубликованным этими компаниями, в сети API есть несколько скрытых жемчужин, которые существуют исключительно для упрощения и улучшения рабочего процесса API для разработчиков, использующих Postman. Вот несколько из них, которые я считаю особенно полезными:
-
Joyce Lin’s Public Workspace Linter изучает содержимое вашего публичного рабочего пространства, чтобы определить, готово ли оно к публичной публикации, и дает вам советы по улучшению.
-
Инструмент автоматизации API First Workflow Patterns Ника Шотта синхронизирует вашу спецификацию OpenAPI с Postman и автоматически обновляет документацию, имитационные серверы и мониторы в вашем рабочем пространстве.
-
Утилита Carson Hunter’s Workspace Cloning Utility даст вам возможность клонировать рабочие пространства и даже сохранять любые форки в коллекциях.
-
Генератор контрактных тестов Аллена Хелтона исследует вашу спецификацию OpenAPI и мгновенно генерирует тесты схемы, чтобы убедиться, что ваша реализация API соответствует опубликованной спецификации.
Утилитарные коллекции на помощь
Я называю эти типы коллекций «полезными коллекциями», потому что они существуют не для того, чтобы представлять API или даже рабочий процесс API в приложении. Вместо этого они существуют для того, чтобы предоставлять некоторые полезные функции, которые улучшают способ использования платформы Postman API Platform разработчиками.
Многие разработчики уже создают и используют коллекции утилит внутри своих команд и между ними, чтобы делать такие вещи, как:
- анализировать тесты на предмет покрытия кода и создавать отчет о покрытии
- проверка файлов спецификаций OpenAPI на соответствие минимальным требованиям
- Расширить подход контрактного тестирования на GraphQL, Protobuf и даже WSDL.
- Находить пробелы в документации и делать их видимыми для владельцев рабочих пространств
- Автоматически переносить общие коллекции в новые рабочие пространства, чтобы разработчики могли сразу же начать работу над ними.
Самое замечательное в этих коллекциях утилит то, что любой может создать их и обнародовать с помощью Postman Public API Network.
У вас есть идея для коллекции утилит?
Хорошая коллекция утилит должна быть простой в использовании и решать единственную проблему пользователя. Если вы собираетесь создать коллекцию утилит, вам следует придерживаться следующих четырех правил:
-
Сосредоточьтесь на одной цели: коллекции утилит не должны пытаться решить слишком много проблем за один раз. Как и в примерах коллекций, приведенных выше, имейте в виду четкую цель — решить одну проблему. Убедитесь, что вы ограничиваете область применения, чтобы упростить что-то для ваших пользователей.
-
Требуйте только несколько легко находимых параметров: Настройка должна быть очень простой для пользователей. Просить пользователей копировать ключи API Postman, идентификаторы рабочих пространств и идентификаторы коллекций — это примерно то, до чего вы хотите дойти. Если есть возможность, используйте переменные коллекции, чтобы сохранить самодостаточность и избавить пользователей от необходимости форка окружения.
-
Предоставляйте хорошую документацию: Хорошая документация поможет пользователю понять, для чего предназначена коллекция, как заставить ее работать и куда обращаться за поддержкой. Прежде чем публиковать коллекцию, убедитесь, что ваша документация соответствует всем требованиям, чтобы ваши пользователи получили отличный опыт.
-
Уважайте рабочее пространство: Если только это не является явной целью, полезные коллекции не должны стремиться к изменению чего-либо в рабочем пространстве, вместо этого лучше просто сообщить пользователю о том, что произошло (с помощью результатов тестирования, визуализации и т.д.) или создать новые коллекции в рабочем пространстве. Не изменяйте существующие данные, если в этом нет необходимости.
Поделитесь своей работой
Как только вы завершите создание собственной коллекции утилит, создайте публичную рабочую область и опубликуйте ее в Postman Public API Network, чтобы поделиться ею с нашим сообществом, насчитывающим более 20 миллионов пользователей.
The post Supercharge Your API Development with Utility Collections appeared first on Postman Blog by Jordan Walsh.