Организация API-first подхода, используя OpenAPI generator и Gitlab CI
Однажды я внедрил в своей команде подход разработки через API-first. Все было классно, мы описывали API спецификации в файле, запускали генерацию, публиковали артефакты в репозиторий, но... это было не удобно.
https://habr.com/ru/articles/884412/
#openapi #openapi_generator #java #spring_framework #spring_boot #api
Генерация кода валидации из спецификации OpenAPI: как мы синхронизировали валидаторы данных между бэкендом и фронтендом
Представьте ситуацию: ваша команда закончила интеграцию с API, все протестировала и подготовила релиз. А тут внезапно серверная команда меняет формат ответа. Фронтенд падает, QA злится, пользователи недовольны. Приходится вручную переписывать валидации, искать баги и терять дни, чтобы всё починить. Как автоматически синхронизировать работу между бэкэндом и фронтендом? А между дизайном и фронтендом? Использовать генератор кода валидации! Написание своего решения поможет понять бизнес-логику проекта и создать валидаторы, которые максимально отвечают вашим требованиям. А реализация проще, чем кажется на первый взгляд – покажу это в статье на примере создания кастомного генератора на нашем проекте. В первую очередь статья будет полезна фронтенд-разработчикам и командам, работающим над сложными веб-приложениями, особенно тем, кто активно взаимодействует с API, описанными через OpenAPI.
https://habr.com/ru/companies/outlines_tech/articles/860566/
#openapi_generator #генератор_кода #json_schema_validator #code_splitting #ast #openapi_specification #api
От документации к готовому API: Генерация кода из Swagger для FastAPI
В статье вы узнаете, как с помощью OpenAPI Generator преобразовать OpenAPI-документацию в рабочие роуты и Pydantic модели для FastAPI. Один раз настроив конфигурацию, вы сможете за секунды создавать готовый код, что значительно ускоряет разработку и упрощает поддержание API. Итак, давайте разбираться!
Генерация PDF-документации из OpenAPI-спецификации в SpringBoot-приложении
При интеграции с нашим приложением, написанном на "классическом" SpringBoot-стэке встал вопрос о предоставлении описания АПИ партнеру. Фактически из коробки SpringBoot позволяет развернуть на стороне приложения тонкий Swagger-клиент и сгенерировать на лету спецификацию в формате Swagger (OpenAPI), которая представляет собой JSON особой структуры (хотя если читатель не знает, что это, наверное нет никакого смысла вообще читать эту статью). Проблема осложнялась тем, что наш партнер разрабатывал на 1С, и во всех современных спецификациях для него были слишком сложно освоиться, поэтому встала задача предоставить документацию в человекориентированном виде - DOC, PDF и прочее. В ходе изысканий в google, была найдена статья - https://www.baeldung.com/swagger-generate-pdf , и советы на stackoverflow, которые фактически повторяли эту статью. Фактически было найдено 2 варианта решения: 1) Использовать онлайн-конвертер https://www.swdoc.org/ 2) Настроить цепочку из 3 maven-плагинов:
