platforms/ide/ide-native/         @gradle/bt-ide-experience @gradle/bt-native-maintainers

# Documentation
platforms/documentation/docs/src/docs/                                                        @gradle/bt-devrel-education
platforms/documentation/docs/src/samples/                                                     @gradle/bt-devrel-education
platforms/documentation/docs/src/docs-asciidoctor-extensions-base/                            @gradle/bt-devrel-education

    On voit bien dans la documentation que `item_id` est déclaré comme entier.

## Les avantages d'avoir une documentation basée sur une norme, et la documentation alternative.

    * FastAPI provides more features on top of Starlette. Features that you almost always need when building APIs, like data validation and serialization. And by using it, you get automatic documentation for free (the automatic documentation doesn't even add overhead to running applications, it is generated on startup).

It was one of the first examples of **automatic API documentation**, and this was specifically one of the first ideas that inspired "the search for" **FastAPI**.

!!! note
    Django REST Framework was created by Tom Christie. The same creator of Starlette and Uvicorn, on which **FastAPI** is based.


!!! check "Inspired **FastAPI** to"
    Have an automatic API documentation web user interface.

        tasks.register("serveDocs", ServeDocs.class, task -> {
            task.setDescription("Runs a local webserver to serve generated documentation.");
            task.setGroup("documentation");

            int webserverPort = 8000;
            task.getJavaLauncher().set(
                task.getProject().getExtensions().getByType(JavaToolchainService.class)

// IntegerType is here for the purposes of documentation only. It is a stand-in
// for any integer type: int, uint, int8 etc.
type IntegerType int

// FloatType is here for the purposes of documentation only. It is a stand-in
// for either float type: float32 or float64.
type FloatType float32

// ComplexType is here for the purposes of documentation only. It is a
// stand-in for either complex type: complex64 or complex128.

    Even if they are in different modules (Python files).

## Exclude from OpenAPI

To exclude a *path operation* from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter `include_in_schema` and set it to `False`:

```Python hl_lines="6"
{!../../../docs_src/path_operation_advanced_configuration/tutorial003.py!}
```

## Advanced description from docstring

* **Facile** : Conçu pour être facile à utiliser et à apprendre. Moins de temps passé à lire la documentation.
* **Concis** : Diminue la duplication de code. De nombreuses fonctionnalités liées à la déclaration de chaque paramètre. Moins de bugs.
* **Robuste** : Obtenez un code prêt pour la production. Avec une documentation interactive automatique.

### Documentation automatique

Documentation d'API interactive et interface web d'exploration. Comme le framework est basé sur OpenAPI, de nombreuses options sont disponibles. Deux d'entre-elles sont incluses par défaut.

    name: 'build_infrastructure'
  - core_configuration:
    name: 'core_configuration'
  - core_execution:
    name: 'core_execution'
  - core_runtime:
    name: 'core_runtime'
  - documentation:
    name: 'documentation'
  - enterprise:
    name: 'enterprise'
  - extensibility:
    name: 'extensibility'
  - ide:
    name: 'ide'
  - jvm:
    name: 'jvm'
  - native:
    name: 'native'
  - software: