platforms/ide/ide-native/         @gradle/bt-tide @gradle/bt-jvm

# Documentation
platforms/documentation/          @gradle/bt-docs-reviewers

platforms/documentation/docs/src/snippets/kotlinDsl/                                                        @gradle/bt-docs-reviewers @gradle/bt-tide

The same way, you can declare any other parameter as normally, and additionally, get the `Request` too.

///

## `Request` documentation { #request-documentation }

You can read more details about the [`Request` object in the official Starlette documentation site](https://www.starlette.dev/requests/).

/// note | Technical Details

You could also use `from starlette.requests import Request`.

* Le _chemin_ `/items/{item_id}` a un _paramètre de requête_ optionnel `q` de type `str`.

### Documentation API interactive { #interactive-api-docs }

Maintenant, rendez-vous sur [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).

Vous verrez la documentation interactive automatique de l'API (fournie par [Swagger UI](https://github.com/swagger-api/swagger-ui)) :

* **Existing code**: British English spellings in existing code should be updated opportunistically when those areas are modified, unless constrained by backward compatibility
* **Documentation**: Documentation should be updated to use American English, prioritizing user-facing documentation

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.

///

though we use GitHub-flavored Markdown for internal documentation too.

You can generate docs by running `./gradlew :docs:docs`.
This will build the whole documentation locally in [platforms/documentation](./platforms/documentation).
For more commands and examples, including local development,
see [this guide](./platforms/documentation/docs/README.md).

### Creating commits and writing commit messages

          args: >
            --no-progress --offline '**/*.md' --include-fragments
            --exclude-path 'platforms/documentation/docs/src/docs/release/notes.md'
            --exclude-path 'platforms/documentation/docs/src/docs/release/notes-template.md'
            --exclude-path 'platforms/documentation/docs/src/docs/kotlin/Module.md'

///

## Documentation { #documentation }

And when you open your browser at [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs), you will see an automatic, interactive, API documentation like:

<img src="/img/tutorial/path-params/image01.png">

/// check

Again, just with that same Python type declaration, **FastAPI** gives you automatic, interactive documentation (integrating Swagger UI).

---

### 💬 **Community Support & Resources**

The Gradle community offers a range of forums, documentation, and direct help to guide you through every step of your Gradle journey:

- **Documentation**: The [Gradle User Manual](https://docs.gradle.org/current/userguide/userguide.html) covers everything from basic to advanced configurations.

## Documentation Tags - OpenAPI { #documentation-tags-openapi }

To add tags to your *path operations*, and group them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Tags](../tutorial/path-operation-configuration.md#tags).

## Documentation Summary and Description - OpenAPI { #documentation-summary-and-description-openapi }