Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Сделать читаемую доку в сваггере в юзердате #9

Closed
viribus-issue-bot opened this issue Jul 29, 2023 · 2 comments · Fixed by #22
Closed
Labels
bug 🐞 Что-то не работает good first issue 👶 Задача подходит для новичков

Comments

@viribus-issue-bot
Copy link

Issue open by Артем Морозов via telegram message.

@grigoriev-semyon grigoriev-semyon removed their assignment Sep 4, 2023
@grigoriev-semyon grigoriev-semyon added good first issue 👶 Задача подходит для новичков bug 🐞 Что-то не работает labels Sep 4, 2023
@grigoriev-semyon
Copy link
Member

Дока в сваггере на данный момент выглядит так
image

Она использует докстринги к функциям, которые не отформатированы в формате .md

Надо сделать так, чтобы в сваггере было только описание того, что ручка делает, но не описание функции из докстринга

Для этого есть спецсимвол после которого сваггер не читает докстринг

@Temmmmmo
Copy link
Member

Почитать про формат описаний в Swagger можно тут

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐞 Что-то не работает good first issue 👶 Задача подходит для новичков
Projects
Archived in project
3 participants