4.8 KiB
Загальне - Як зробити - Рецепти
Нижче наведено кілька вказівок до інших розділів документації для загальних або частих питань.
Фільтрування даних - Безпека
Щоб гарантувати, що ви не повертаєте більше даних, ніж слід, прочитайте документацію Навчальний посібник - Модель відповіді - Тип повернення.
Оптимізувати продуктивність відповіді - Модель відповіді - Тип повернення
Щоб оптимізувати продуктивність під час повернення даних JSON, використовуйте тип повернення або модель відповіді, таким чином Pydantic виконуватиме серіалізацію в JSON на боці Rust, без проходження через Python. Докладніше читайте в документації Навчальний посібник - Модель відповіді - Тип повернення.
Мітки документації - OpenAPI
Щоб додати мітки до ваших операцій шляху та згрупувати їх в інтерфейсі документації, прочитайте документацію Навчальний посібник - Налаштування операції шляху - Мітки.
Короткий опис і опис - OpenAPI
Щоб додати короткий опис і опис до ваших операцій шляху і показати їх в інтерфейсі документації, прочитайте документацію Навчальний посібник - Налаштування операції шляху - Короткий опис і опис.
Опис відповіді в документації - OpenAPI
Щоб визначити опис відповіді, що відображається в інтерфейсі документації, прочитайте документацію Навчальний посібник - Налаштування операції шляху - Опис відповіді.
Позначити застарілою операцію шляху - OpenAPI
Щоб позначити операцію шляху як застарілу і показати це в інтерфейсі документації, прочитайте документацію Навчальний посібник - Налаштування операції шляху - Позначення як застаріле.
Перетворити будь-які дані на сумісні з JSON
Щоб перетворити будь-які дані на сумісні з JSON, прочитайте документацію Навчальний посібник - Кодувальник, сумісний з JSON.
Метадані OpenAPI - Документація
Щоб додати метадані до вашої схеми OpenAPI, зокрема ліцензію, версію, контактні дані тощо, прочитайте документацію Навчальний посібник - Метадані та URL документації.
Власний URL OpenAPI
Щоб налаштувати URL OpenAPI (або прибрати його), прочитайте документацію Навчальний посібник - Метадані та URL документації.
URL документації OpenAPI
Щоб оновити URL, які використовуються для автоматично згенерованих інтерфейсів користувача документації, прочитайте документацію Навчальний посібник - Метадані та URL документації.