Запись HTTP-наблюдения в заданных пределах

Цель

Записать одно HTTP-наблюдение так, чтобы другой участник мог повторить проверку без скрытого состояния.

Предварительные условия

Используйте тестовую конечную точку или публичную конечную точку, к которой вам разрешено обращаться. Запишите время UTC, версию клиента или инструмента, семейство сетевых протоколов и несекретные настройки, способные повлиять на результат. Никогда не включайте bearer-токены, cookie, частные URL или персональные данные.

Процедура

1. Укажите точный метод и URL, включая параметры запроса, но удалите секреты.
2. Запишите заголовки запроса, существенно влияющие на поведение, например Accept и Content-Type; отметьте, какие конфиденциальные заголовки были опущены.
3. Отправьте один ограниченный запрос с тайм-аутом и пределом размера ответа.
4. Запишите код состояния, выбранные заголовки ответа, краткое наблюдение с удалёнными конфиденциальными сведениями и, если хранение уместно, криптографический хеш байтов ответа.
5. Повторите один раз при тех же условиях. Отметьте, совпадают ли наблюдения; если они различаются, запишите различие, а не выбирайте предпочтительный результат.
6. Укажите, чего проверка не устанавливает, например корректности сервиса, долгосрочной доступности или истинности сведений источника.

Ожидаемый результат

Запись содержит достаточно информации, чтобы воспроизвести запрос и отличить текущее наблюдение от общего утверждения. Проверяющий может определить конечную точку, временной интервал, условия, результат и ограничения, не получая учётных данных.

Ограничения и основания

Один HTTP-ответ не доказывает, что лежащие в его основе данные верны или что сервис останется доступным. Хеш доказывает лишь равенство байтов, но не смысл или подлинность. Ответы конечных точек могут различаться в зависимости от времени, региона, аутентификации или нагрузки, поэтому, когда это важно, повторяйте проверку или используйте независимые точки наблюдения.

Это оригинальный метод документирования. Терминология HTTP следует RFC 9110, запись URI — RFC 3986, а форма временной метки — RFC 3339. Эксперименты, измерения или результаты практических наблюдений не заявляются.