* Gerar definições de [JSON Schema](https://json-schema.org) para o seu modelo; você também pode usá-las em qualquer outro lugar se fizer sentido para o seu projeto.
* Esses schemas farão parte do esquema OpenAPI gerado, e serão usados pelas <abbr title="User Interfaces - Interfaces de usuário">UIs</abbr> de documentação automática.

## Documentação automática { #automatic-docs }

---

O **FastAPI** não faz nenhuma concessão com nenhum banco de dados, modelo de dados ou ferramenta.

Ele oferece toda a flexibilidade para você escolher as opções que melhor se ajustam ao seu projeto.

E você pode usar diretamente muitos pacotes bem mantidos e amplamente utilizados, como `pwdlib` e `PyJWT`, porque o **FastAPI** não exige mecanismos complexos para integrar pacotes externos.

/// note | Detalhes Técnicos

Os cabeçalhos do proxy são:

* [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Forwarded-For)
* [X-Forwarded-Proto](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Forwarded-Proto)
* [X-Forwarded-Host](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Forwarded-Host)

///

labels.sidebar.placeholder_search=Pesquisar...
labels.menu_plugin=Plugin
labels.menu_storage=Armazenamento
labels.sidebar.menu=Menu
labels.footer.copyright=&copy;2026 <a href="https://github.com/codelibs">Projeto CodeLibs</a>.
labels.search=Pesquisar
labels.similar_doc_result_status=Mostrando resultados semelhantes.

Ele contém um `APIRouter` com algumas *operações de rota* de administração que sua organização compartilha entre vários projetos.

Para este exemplo, será super simples. Mas digamos que, como ele é compartilhado com outros projetos na organização, não podemos modificá-lo e adicionar um `prefix`, `dependencies`, `tags`, etc. diretamente ao `APIRouter`:

    Path getRootDirectory();

    /**
     * Returns project parent project, if any.
     * <p>
     * Note that the model may have a parent defined, but an empty parent
     * project may be returned if the parent comes from a remote repository,
     * as a {@code Project} must refer to a buildable project.
     *
     * @return an optional containing the parent project
     * @see Model#getParent()
     */
    @Nonnull

<component name="ProjectCodeStyleConfiguration">
  <code_scheme name="Project" version="173">
    <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
    <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
    <option name="IMPORT_LAYOUT_TABLE">
      <value>
        <package name="" withSubpackages="true" static="true" />
        <emptyLine />
        <package name="" withSubpackages="true" static="false" />
        <emptyLine />

        System.out.println("Location of project-4's POM: " + pom4.getPath());

        // load everything...
        MavenProject project0 = getProject(pom0);
        MavenProject project1 = getProject(pom1);
        MavenProject project2 = getProject(pom2);
        MavenProject project3 = getProject(pom3);
        MavenProject project4 = getProject(pom4);
        MavenProject project5 = getProject(pom5);

    </description>
  </expression>
  <expression>
    <syntax>project.artifact</syntax>
    <configuration>
      <![CDATA[
<groupId>project.group</groupId>
<artifactId>project-artifact</artifactId>
<version>0.0.0.0</version>
<packaging>type</packaging>
    ]]></configuration>
    <description> This is the Artifact instance created from the essential project

Les modèles, bien qu'ils soient généralement livrés avec une configuration spécifique, sont conçus pour être flexibles et personnalisables. Cela vous permet de les modifier et de les adapter aux exigences de votre projet, ce qui en fait un excellent point de départ. 🏁

Vous pouvez utiliser ce modèle pour démarrer, car il inclut une grande partie de la configuration initiale, la sécurité, la base de données et quelques endpoints d'API déjà prêts pour vous.