14 ноября 2019 г. 19:41

400

Swagger для Django Rest Framework

Зачем нам нужно документировать API ? Что за такие страшные слова Swagger и OpenApi ? Каквя между ними разница? Как легко подключить Swagger документацию вашим эндпоинтам , реализванные на DRF? Все в этой статье

OpenApi - это официальное название спецификация .Разработкой спецификации занимается больше 30 компаний, включая Microsoft, Google, IBM и другие.

Swagger - это инструменты для реализации OpenApi спецификации.Набор инструментов Swagger включает в себя набор открытых, бесплатных и коммерческих инструментов, которые можно использовать на разных этапах жизненного цикла API.

Swagger UI - это коллекция Html, js css документов , которые генерируют прекрасную документацию.

Для Django Rest Framework мы будем использовать библиотеку drf-yasg

В комплекте последняя версия Swagger Ui и Redoc

Сгенерированная схема Swagger может быть автоматически проверена с помощью swagger-spec-validator

Swagger-spec-validator - это библиотека Python, которая проверяет спецификации Swagger на соответствие спецификации Swagger 1.2 или Swagger 2.0. Валидатор стремится проверить на полное соответствие Спецификации.

comments powered by Disqus