5 месяцев назад
Используем Swagger (OpenAPI) для документирования и спецификации контроллеров в Spring Boot на Java
В современной разработке REST API важно не только писать код, но и документировать его так, чтобы: Swagger (ныне OpenAPI) — это стандарт и инструмент, который автоматически генерирует документацию на основе аннотаций в вашем Java-коде. В этой статье мы подробно разберём, как использовать Springdoc OpenAPI (современная замена Springfox) для документирования контроллеров, просмотра API в UI . ✅ Для Java 11 и Spring Boot 2.7+ — Springdoc OpenAPI является де-факто стандартом. Добавьте в pom.xml: <!-- Springdoc OpenAPI UI — для генерации документации и Swagger UI --> <dependency> <groupId>org...
254 читали · 2 года назад
Django и Swagger
Swagger – это инструмент и фреймворк для создания и генерации API документации. Swagger позволяет разработчикам описывать свойства, методы и запросы для своих API, а затем генерировать документацию в формате HTML, JSON или Markdown. Swagger также предоставляет возможность прокси-сервера для тестирования API на различных этапах разработки. Swagger был создан в 2011 году компанией Reverb Technologies и с того времени стал де-факто стандартом для создания API документации. В 2015 году Swagger был объединен с фреймворком OpenAPI, и сейчас они используются взаимозаменяемо...
619 читали · 3 года назад
OpenAPI vs Swagger: детальный разбор
👋🏻 Привет! С вами снова Merion Academy - платформа доступного IT образования. OpenAPI Spec – излюбленный выбор экспертов по разработке API, особенно если главным приоритетом является безопасность. Инструментарий Swagger в этом отношении кажется хорошим вспомогательным средством. Однако пытаться совместить эти два понятия – настоящая задача. Вы, наверное, уже запутались? Не беспокойтесь. Эта статья поможет вам во всем разобраться. OpenAPI: хронология его создания OpenAPI – это всемирно признанная проектная спецификация RESTful API, разработанная под эгидой OpenAPI Initiative...
Погружение в Swagger: от основ до сложных кейсов в Nest.js
Привет! Меня зовут Александр Панфилов, я фронтенд-разработчик и тимлид с 9-летним опытом. В этой статье я хочу поделиться своим опытом глубокой работы со Swagger — инструментом, который кажется простым только на первый взгляд. На практике же его тонкости могут отнять немало времени, и сегодня я разберу именно те моменты, которые потребовали от меня наибольших усилий. В своей работе столкнулся с тем, что Swagger игнорирует мой заголовок authorization; не знал, как описать два разных типа запросов к одному эндпоинту и т...