Вопрос по описанию API. В каком виде вы это делаете?

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

0

20.11.2023

Eduard Tibet

Arina Ballerina
точно так же. примерно представляете как работает ...

Из исходных данных непонятно, существуют ли реальные рабочие входные точки для проверки этого API или существующее = существует на бумаге :)

0

20.11.2023

Natalia Автор вопроса

Eduard Tibet
Тут, наверное, зависит от того, что именно вам над...

Да если бы знала )) я вижу в вакансиях - описание апи. Вот и интересуюсь, могу я это делать или нет исходя из моих знаний и учебного опыта

0

20.11.2023

Arina Ballerina

Eduard Tibet
Из исходных данных непонятно, существуют ли реальн...

я не поняла ничего сейчас если честно. человек же написал что сам всё создал, своими руками

0

20.11.2023

Natalia Автор вопроса

Да, задание было спроектировать сервис бронирования билетов

0

20.11.2023

Eduard Tibet

Я исходил из вашей реплики "отправляете запросы". Т.е. сервис должен существовать :)

0

20.11.2023

Eduard Tibet

Natalia
Да, задание было спроектировать сервис бронировани...

Вы лучше опишите немного подробнее исходные данные, ибо они фрагментарны и ваши коллеги в чатике (я в том числе) гадают, что имеется в виду под вашими исходными данными. Описать можно, например, так: 1. Мне дали тестовое задание (или я решила сделать сама то-то и то-то). 2. Исходные данные: A, B, C 3. На выходе мне нужно получить X,Y,Z. 4. Требования к форматам: K,L,M

0

20.11.2023

Natalia Автор вопроса

Eduard Tibet
Я исходил из вашей реплики "отправляете запросы". ...

Ну шваггер же выдаёт, если ошибки были при проектировании

0

20.11.2023

Eduard Tibet

Natalia
Ну шваггер же выдаёт, если ошибки были при проекти...

Секунду... Вы имеете в виду ошибки _описания_ (формата) или ошибки в ответах сервиса? Это две разные вещи!!!

0

20.11.2023

Arina Ballerina

Natalia
Да если бы знала )) я вижу в вакансиях - описание...

трудно советовать не зная всех подробностей но попробуйте это видео, может вам подойдет, я там рассказываю как документировать апи. правда это было 10 лет назад, но если честно не очень многое из того что я говорю устарело: https://events.yandex.ru/events/hyperbaton/msk-may-2014?openTalkVideo=440-3 #знания #гипербатон #api

0

20.11.2023

rJIynbIu` KOT

Natalia
Ну шваггер же выдаёт, если ошибки были при проекти...

пожалуйста, не называйте сваггер шваггером, умоляю

0

20.11.2023

Ed P

Natalia
Ну шваггер же выдаёт, если ошибки были при проекти...

Простите, а почему шваггер? Это же не Шварцнеггер. Есть еще такое слово SWAG, мне казалось сваггер (свэггер) его обыгрывает

0

20.11.2023

Arina Ballerina · Accepted Answer

если вы сгенерировали описание апи, так, что пользователям понятно, что это за апи и как им пользоваться, то что вас смущает? почему вы сомневаетесь? нет какого-то одного правильного инструмента, который используется для документирования апи #карьера #api

Похожие чаты

Вопрос по описанию API. В каком виде вы это делаете?

27 ответов

Похожие вопросы