Похожие чаты

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

Есть у меня учебный проект. Описать методы и типы данных в эксель, а потом в swagger

27 ответов

10 просмотров
Natalia- Автор вопроса

Так, или ещё что?

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

Natalia
Так, или ещё что?

у вас получается пользоватьтся апи по вашей документации? пробовали отправлять запросы?

Natalia
Так, или ещё что?

можно попробовать протестить на ком-то из своих разработчиков. понятно им или нет. в Swagger, думаю, проблем вообще не будет

Ksenia Yakushina
можно попробовать протестить на ком-то из своих ра...

там у человека учебный проект. скорее всего нет разработчиков

Natalia
Так, или ещё что?

посмотрите документацию Ю Касса API

поясните, пожалуйста, вы пишете спецификацию к апи? апи уже существует или ещё нет?

Arina Ballerina
хорошая?

и хорошая, и в принципе расписано подробно, для обучения вообще отлично

Lidia Tulyaganova
и хорошая, и в принципе расписано подробно, для об...

вот это? https://yookassa.ru/developers меня покорил этот заголовок: Не подходит API? Есть другие решения💙 #знания #api

Вот ещё для примера, мне нравится https://github.com/hhru/api

Natalia- Автор вопроса
Arina Ballerina
поясните, пожалуйста, вы пишете спецификацию к апи...

Нет. Это учебный проект. Задание спроектировать апи и протестировать в шваггере. А вот как описывать существующий - я не знаю

Natalia- Автор вопроса
Natalia
Нет. Это учебный проект. Задание спроектировать а...

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

Natalia
Нет. Это учебный проект. Задание спроектировать а...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Обсуждают сегодня

А кто-то пробовал, уезжая из Эстонии получить э-рез и продолжить вести предпринимательскую деятельность внутри Эстонии, используя свой OÜ?
Lalalashechki Lalala
57
@MrMiscipitlick А можешь макрос написать, который будет вычислять смещение относительно переданных меток? Просто .label1-.label2, и вернуть значение.
КТ315
35
я не магистр хаскеля, но разве не может лейзи тип конвертнуться в не-лейзи запросив вычисление содержимого прям при инициализации?
deadgnom32 λ madao
100
А еще в перле можно уже @arr1 + @arr2?
Sergei Zhmylove
53
Does anyone here have a connection Mullvad? it would be nice to know what it would take to have them accept BCH 0-conf.
tl121x
16
Подобного рода ;Следующие три строки это директивы ассемблера, ;которые можно не задавать, т.к.работаем в Visual Studio. ;Символ ";" - это начало однострочного комментария ...
Егор Анелькин
3
@samkazemian - couple questions: Update on frxBTC? - This would do well with the current influx of institutional investment entering the space Update on future veFXS streams...
Costi
9
Can an XMR transaction be tracked from its sender to its receiver by performing blockchain analysis, no matter how many addresses are used?
Trkz342
15
I arrived here after a Chico Crypto show highlighted the project & the Team - the fact that the Team had a long history of successfully working with household names gave me e...
Banter is Bullish
5
Привет всем. появился вопрос. Разрабатываю сайт, в данный момент он запущен. Хостинг beget. Добавляю на сайт яндекс метрику с помощью полей client-settings (взято отсюда http...
Andrew
2
Карта сайта