---
- job:
    name: elastic+elasticsearch+%BRANCH%+multijob+platform-support-unix
    display-name: "elastic / elasticsearch # %BRANCH% - unix compatibility"
    description: "Elasticsearch %BRANCH% unix compatibility testing.\n"
    project-type: matrix
    node: master
    scm:
      - git:
          wipe-workspace: false
    axes:
      - axis:
          type: label-expression
          name: os
          values:

---
title: Recipes
description: A collection of common/useful code examples for Kotlin and Java
---


# Recipes

We've written some recipes that demonstrate how to solve common problems with OkHttp. Read through them to learn about how everything works together. Cut-and-paste these examples freely; that's what they're for.

### Synchronous Get ([.kt][SynchronousGetKotlin], [.java][SynchronousGetJava])

{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *}

## Descripción avanzada desde el docstring { #advanced-description-from-docstring }

Puedes limitar las líneas usadas del docstring de una *path operation function* para OpenAPI.

{* ../../docs_src/body_nested_models/tutorial004_py310.py hl[18] *}

Das würde bedeuten, dass **FastAPI** einen Body wie folgt erwartet:

```JSON
{
    "name": "Foo",
    "description": "The pretender",
    "price": 42.0,
    "tax": 3.2,
    "tags": ["rock", "metal", "bar"],
    "image": {
        "url": "http://example.com/baz.jpg",
        "name": "The Foo live"
    }
}
```

                        "summary": "Root",
                        "operationId": "root__get",
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                    }
                }
            },

Это могут быть буквально одна-две строки кода, например:

```Python
callback_url = "https://example.com/api/v1/invoices/events/"
httpx.post(callback_url, json={"description": "Invoice paid", "paid": True})
```

{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *}

## Fortgeschrittene Beschreibung mittels Docstring { #advanced-description-from-docstring }

Sie können die verwendeten Zeilen aus dem Docstring einer *Pfadoperation-Funktion* einschränken, die für OpenAPI verwendet werden.

        },
        "enable": true,
        "hide": true,
        "iconColor": "rgba(0, 211, 255, 1)",
        "name": "Annotations & Alerts",
        "type": "dashboard"
      }
    ]
  },
  "description": "MinIO Grafana Dashboard - https://min.io/",
  "editable": true,
  "fiscalYearStartMonth": 0,
  "gnetId": 15306,
  "graphTooltip": 0,
  "id": 283,
  "links": [
    {
      "icon": "external link",

Y probablemente variará mucho de una aplicación a otra.

Podría ser solo una o dos líneas de código, como:

```Python
callback_url = "https://example.com/api/v1/invoices/events/"
httpx.post(callback_url, json={"description": "Invoice paid", "paid": True})
```

* `version`: Версия вашего API, например `2.5.0`.
* `openapi_version`: Версия используемой спецификации OpenAPI. По умолчанию — последняя: `3.1.0`.
* `summary`: Краткое описание API.
* `description`: Описание вашего API; может включать Markdown и будет отображаться в документации.
* `routes`: Список маршрутов — это каждая зарегистрированная *операция пути*. Берутся из `app.routes`.

/// info | Информация