Есть у меня учебный проект. Описать методы и типы данных в эксель, а потом в swagger
Так, или ещё что?
если вы сгенерировали описание апи, так, что пользователям понятно, что это за апи и как им пользоваться, то что вас смущает? почему вы сомневаетесь? нет какого-то одного правильного инструмента, который используется для документирования апи #карьера #api
у вас получается пользоватьтся апи по вашей документации? пробовали отправлять запросы?
можно попробовать протестить на ком-то из своих разработчиков. понятно им или нет. в Swagger, думаю, проблем вообще не будет
там у человека учебный проект. скорее всего нет разработчиков
посмотрите документацию Ю Касса API
поясните, пожалуйста, вы пишете спецификацию к апи? апи уже существует или ещё нет?
и хорошая, и в принципе расписано подробно, для обучения вообще отлично
вот это? https://yookassa.ru/developers меня покорил этот заголовок: Не подходит API? Есть другие решения💙 #знания #api
Вот ещё для примера, мне нравится https://github.com/hhru/api
Нет. Это учебный проект. Задание спроектировать апи и протестировать в шваггере. А вот как описывать существующий - я не знаю
Ну не было такого задания ))
точно так же. примерно представляете как работает апи, отправляете запросы, уточняете своё представление об апи, описываете это для других
Тут, наверное, зависит от того, что именно вам надо описывать в существующем и какая входная информация вам приходит. Если я неправильно понял вопрос, то требуется уточнение.
Из исходных данных непонятно, существуют ли реальные рабочие входные точки для проверки этого API или существующее = существует на бумаге :)
Да если бы знала )) я вижу в вакансиях - описание апи. Вот и интересуюсь, могу я это делать или нет исходя из моих знаний и учебного опыта
я не поняла ничего сейчас если честно. человек же написал что сам всё создал, своими руками
Да, задание было спроектировать сервис бронирования билетов
Я исходил из вашей реплики "отправляете запросы". Т.е. сервис должен существовать :)
Вы лучше опишите немного подробнее исходные данные, ибо они фрагментарны и ваши коллеги в чатике (я в том числе) гадают, что имеется в виду под вашими исходными данными. Описать можно, например, так: 1. Мне дали тестовое задание (или я решила сделать сама то-то и то-то). 2. Исходные данные: A, B, C 3. На выходе мне нужно получить X,Y,Z. 4. Требования к форматам: K,L,M
Ну шваггер же выдаёт, если ошибки были при проектировании
Секунду... Вы имеете в виду ошибки _описания_ (формата) или ошибки в ответах сервиса? Это две разные вещи!!!
трудно советовать не зная всех подробностей но попробуйте это видео, может вам подойдет, я там рассказываю как документировать апи. правда это было 10 лет назад, но если честно не очень многое из того что я говорю устарело: https://events.yandex.ru/events/hyperbaton/msk-may-2014?openTalkVideo=440-3 #знания #гипербатон #api
пожалуйста, не называйте сваггер шваггером, умоляю
Простите, а почему шваггер? Это же не Шварцнеггер. Есть еще такое слово SWAG, мне казалось сваггер (свэггер) его обыгрывает
Обсуждают сегодня