### Documentación automática { #automatic-docs }

Interfaces web de documentación y exploración de APIs interactivas. Como el framework está basado en OpenAPI, hay múltiples opciones, 2 incluidas por defecto.

* [**Swagger UI**](https://github.com/swagger-api/swagger-ui), con exploración interactiva, llama y prueba tu API directamente desde el navegador.

```JSON
{"message": "Hello World"}
```

### Interaktive API-Dokumentation { #interactive-api-docs }

Gehen Sie als Nächstes auf [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).

Sie werden die automatisch erzeugte, interaktive API-Dokumentation sehen (bereitgestellt durch [Swagger UI](https://github.com/swagger-api/swagger-ui)):

                Arguments.of(true, new String[] {"--force-interactive"}, false),
                Arguments.of(true, new String[] {"--force-interactive", "--non-interactive"}, false),
                Arguments.of(true, new String[] {"--force-interactive", "--batch-mode"}, false),
                Arguments.of(true, new String[] {"--force-interactive", "--non-interactive", "--batch-mode"}, false),

                .longOpt("batch-mode")
                .desc("Run in non-interactive mode. Alias for --non-interactive (kept for backwards compatability)")
                .build());
        options.addOption(Option.builder()
                .longOpt(NON_INTERACTIVE)
                .desc("Run in non-interactive mode. Alias for --batch-mode")
                .build());
        options.addOption(Option.builder()

/**
 * Provides the API for the Maven Shell tool ({@code mvnsh}).
 *
 * <p>This package contains interfaces and classes for the interactive Maven shell,
 * which provides a command-line interface for executing Maven commands and
 * managing build environments.</p>
 *
 * <p>Key features include:</p>
 * <ul>
 *   <li>Interactive command-line interface</li>
 *   <li>Command history and completion</li>
 *   <li>Built-in shell commands</li>

    }

    @Override
    public int execute(EncryptContext context) throws Exception {
        if (!context.interactive) {
            context.terminal.writer().println("This tool works only in interactive mode!");
            context.terminal
                    .writer()
                    .println("Tool purpose is to configure password management on developer workstations.");
            context.terminal

**FastAPI** is based on **OpenAPI**.

That's what makes it possible to have multiple automatic interactive documentation interfaces, code generation, etc.

OpenAPI has a way to define multiple security "schemes".

By using them, you can take advantage of all these standard-based tools, including these interactive documentation systems.

OpenAPI defines the following security schemes:

* The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.

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

Now go to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).

You will see the automatic interactive API documentation (provided by [Swagger UI](https://github.com/swagger-api/swagger-ui)):

    zypper ar http://download.opensuse.org/distribution/12.3/repo/oss/ oss
    zypper --non-interactive  --gpg-auto-import-keys refresh
    zypper --non-interactive install git-core
    # choose to "ignore some dependencies" of expect, which has a problem with tcl...
    zypper --non-interactive install --force-resolution expect
  SHELL
  suse_common config, name, extra: extra
end

**FastAPI** est basé sur **OpenAPI**.

C'est ce qui rend possibles plusieurs interfaces de documentation interactive automatiques, la génération de code, etc.

OpenAPI propose une manière de définir plusieurs « schémas » de sécurité.

En les utilisant, vous pouvez tirer parti de tous ces outils basés sur des standards, y compris ces systèmes de documentation interactive.

OpenAPI définit les schémas de sécurité suivants :