Похожие чаты

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

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

27 ответов

27 просмотров
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, мне казалось сваггер (свэггер) его обыгрывает

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

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

Всем привет! Имеется функция: function IsValidChar(ch: UTF8Char): Boolean; var i: Integer; ValidChars: AnsiString; begin ValidChars := 'abcdefghijklmnopqrstuvwxyzABCDE...
Евгений
44
Ну вот просто даже давайте вот как. Какой нибудь конкретный кейс, можете в пример привести, где бч работает и приносит прикладную пользу, а не просто что бы было? Не крипту.
Alexander Andreev
22
For all those that keep asking why no pump? why this ? and why that...? Please close ur ewt chart and open 2 others - TOTAL (total mc) and BTC.D (btc dominance). Maybe BTC a...
Inn3r_G
19
"Since pnut can flip FTM easily, I'm swapping my FTM to pnut and hoping for a easy x5-x10" Perfect recipe for disaster. NFA but chances are, you'll end up as exit liquidity ...
C. A.
7
объясните пожалуйста, почему функция не работает должным образом? вроде должно брать активное окно сравнивать его размер с размером экрана, и если есть совпадение = true прове...
JF
9
AMD status update? No longer in the plan but something might be around the corner later on Chinese partner? No longer in the plan. This market does not seem to be the top ...
Ben
6
Ready for some fun AND a chance to win TKO Tokens? Join us for exciting minigames in our Telegram group! 🕒 Don’t miss out—games start on today 25 October 2024, at 8 PM! Ge...
Milkyway | Tokocrypto
255
да кстати заметил всюда почему то всех сюда прёт, ни в одном чате столько ботов не прёт как сюда.. Может чота надо доработать?
REDis
15
Мне вот любопытно. Уже сколько времени имею соблазн купить макбук, ибо подозреваю что очень уж удобен будет в связке с другой техникой от эпл которая у меня есть, да и сам по ...
Not Yeromin
14
I get confused when people talk about the ‘bull market’ and the ‘next bull market’ as if anyone really has a clue what’s really going on in the world. First of all - there i...
Shah
1
Карта сайта