Общее — Как сделать — Рецепты¶
Здесь несколько указателей на другие места в документации для общих или частых вопросов.
Фильтрация данных — Безопасность¶
Чтобы убедиться, что вы не возвращаете больше данных, чем следует, прочитайте документацию: Руководство — Модель ответа — Возвращаемый тип.
Теги в документации — OpenAPI¶
Чтобы добавить теги к вашим операциям пути и группировать их в интерфейсе документации, прочитайте документацию: Руководство — Конфигурации операций пути — Теги.
Краткое описание и описание в документации — OpenAPI¶
Чтобы добавить краткое описание и описание к вашим операциям пути и отобразить их в интерфейсе документации, прочитайте документацию: Руководство — Конфигурации операций пути — Краткое описание и описание.
Описание ответа в документации — OpenAPI¶
Чтобы задать описание ответа, отображаемое в интерфейсе документации, прочитайте документацию: Руководство — Конфигурации операций пути — Описание ответа.
Документация — пометить операцию пути устаревшей — OpenAPI¶
Чтобы пометить операцию пути как устаревшую и показать это в интерфейсе документации, прочитайте документацию: Руководство — Конфигурации операций пути — Пометить операцию пути устаревшей.
Преобразование любых данных к формату, совместимому с JSON¶
Чтобы преобразовать любые данные к формату, совместимому с JSON, прочитайте документацию: Руководство — JSON-совместимый кодировщик.
Метаданные OpenAPI — Документация¶
Чтобы добавить метаданные в вашу схему OpenAPI, включая лицензию, версию, контакты и т.д., прочитайте документацию: Руководство — Метаданные и URL документации.
Пользовательский URL OpenAPI¶
Чтобы настроить URL OpenAPI (или удалить его), прочитайте документацию: Руководство — Метаданные и URL документации.
URL документации OpenAPI¶
Чтобы изменить URL, используемые для автоматически сгенерированных пользовательских интерфейсов документации, прочитайте документацию: Руководство — Метаданные и URL документации.