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

Изменить названия эндпоинтов #103

Open
ArtemBalandin81 opened this issue Jan 3, 2025 · 0 comments
Open

Изменить названия эндпоинтов #103

ArtemBalandin81 opened this issue Jan 3, 2025 · 0 comments
Labels
good first issue Good for newcomers refactoring Refactorings and optimizations

Comments

@ArtemBalandin81
Copy link
Owner

ArtemBalandin81 commented Jan 3, 2025

Why?

По стандартам REST Не стоит включать в название ресурса имя HTTP-метода:

How Does It Work Now?

Сейчас в названиях встречаются название методов, например так:
POST:
/api/suspensions/post_suspension_with_files_form

А должно быть:
POST:
/api/suspensions/suspension_with_files_form

Или более вопиюще (зачем get_files_unused):
DELETE:
/api/files/get_files_unused

How To Do?

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

Important

Важно сохранить идентичность api.

Where?

src/somewhere.py
src/somewhere/somewhere/somewhere.py

@ArtemBalandin81 ArtemBalandin81 added good first issue Good for newcomers refactoring Refactorings and optimizations labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers refactoring Refactorings and optimizations
Projects
None yet
Development

No branches or pull requests

1 participant