А
Можете этот курс по документированию API почитать https://starkovden.github.io/
Size: a a a
2021 October 12
А
про Postman там тоже есть раздел https://starkovden.github.io/submit-requests-postman.html
S
S
Спасибо вам огромное!
А
Конкретизируйте задачу в целом. Что вам нужно сделать в итоге?
Если задокументировать API в самом postman, то смотрите официальную документацию https://learning.postman.com/docs/publishing-your-api/documenting-your-api/
Если задокументировать API в самом postman, то смотрите официальную документацию https://learning.postman.com/docs/publishing-your-api/documenting-your-api/
А
Если нужно вообще разобраться, как документировать API, то пройдите курс, который я скинул выше
S
Вот поставленные руководством задачи
А
Для примера
https://yandex.ru/dev/direct/
https://developer.sberbank.ru/doc
https://developers.xsolla.com/ru/pay-station-api/
Я не говорю, что это идеальные примеры. Просто ищите API у популярных русскоязычных продуктов
https://yandex.ru/dev/direct/
https://developer.sberbank.ru/doc
https://developers.xsolla.com/ru/pay-station-api/
Я не говорю, что это идеальные примеры. Просто ищите API у популярных русскоязычных продуктов
S
S
Данный пример документации понравился руководству
S
Спасибо за отклик и помощь. Очень вам признательна
А
то есть сейчас документация API уже есть?
S
Есть. Но она в зачаточном, ужасном состоянии
А
поищите по чату примеры API документации, постоянно такие темы всплывают.
А
Инструменты выбраны?
S
Да - Postman
ET
У меня только один вопрос: написано "стандартизировать название интерфейсов". Т.е., получается вам надо переделать пути эндпоинтов в OAS3? Но если вы переделаете, это же надо делать на программной стороне, чтобы описанные эндпоинты обрабатывались. Или под "названием" имеется в виду что-то другое?
BF
Предполагается, что это нужно делать до того, как кто-то начнёт пользоваться вашим АПИ. А так конечно придётся все имплементации апдейтить
S
Узнала. Под данным предложением - стандартизировать название интерфейсов, руководитель имел ввиду привезти стиль написания всех заголовков доки в хоть какой-то маломальски божеский вид 😊
ET
А сам документ у вас основан на OAS3? Или какое-то другое API, которое не является REST?