Русский  English  Все проекты

PHP: Обновить документацию и добавить защиту для RESTful API вызовов



У PHP-бекенда есть порядка 50-ти публичных RESTful API вызовов, почти все они так или иначе связаны с CRUD таблиц из базы. Есть публичное описание этого API для внешних пользователей, которое по стилю похоже на Swagger, но не swagger - было написано вручную. Файл описания - HTML простой JS.

Описание местами неполное, неточное, содержит ошибки. Например, в описании указано что параметр у вызова целое число, а на самом деле API принимает текстовую константу из словаря (это видно по коду реализации API на PHP). Также многие вызовы API не содержат никаких проверок на корректность передаваемых данных или проверок недостаточно, т.е. вызов API с некорректными параметрами может сломать схему данных в БД.

Необходимо внимательно посмотреть код реализации всех API вызовов, обновить исправить и дописать справку по ним чтобы было похоже на Swagger, и добавить защиты от некорректных вызовов.

БД - MariaDB и Postgre (поддерживаются обе), для развертывания используется Docker. Фронт Angular. Фреймворк бека самодельный, есть роутинг запросов.

В откликах пишите про свой опыт в аналогичных проектах. Если задание будет выполнено качественно и в адекватные сроки - будет долгосрочное сотрудничество по проекту.
24.12.2022 15:49



 Ответы фрилансеров