473 читали · 1 год назад
Документирование. Стандарты API часть 1
Продолжаем наше обучению языку python. 18-е практическое занятие, в которое входит: Задача 1. Создание документации к API Добавьте документацию для ресурсов, которые реализовали в практической работе прошлого модуля. Напишите спецификацию для api/books/ в формате YAML, а для api/authors/ — в формате JSON или Python-словаря. Если в прошлом модуле вы использовали Flask-RESTX, можете применить возможности этой библиотеки по созданию Swagger-документации. Узнать о них подробнее можно в этой статье. Первым...
5 месяцев назад
Что такое YAML и зачем он нужен
YAML (YAML Ain't Markup Language) — это формат сериализации данных, который используется для представления структурированных данных в удобочитаемом виде. Он был разработан для простоты и ясности, что делает его особенно популярным в таких областях, как конфигурация приложений, обмен данными между языками программирования и хранение данных. YAML использует отступы для представления вложенности. Пример: В этом примере мы видим, как информация о человеке представлена в виде иерархической структуры...