Como **FastAPI** es en realidad **Starlette** por debajo, con una capa de varias herramientas encima, puedes usar el objeto <a href="https://www.starlette.dev/requests/" class="external-link" target="_blank">`Request`</a> de Starlette directamente cuando lo necesites.

Ocultar la documentación solo hace que sea más difícil entender cómo interactuar con tu API y podría dificultar más depurarla en producción. Podría considerarse simplemente una forma de <a href="https://en.wikipedia.org/wiki/Security_through_obscurity" class="external-link" target="_blank">Seguridad mediante oscuridad</a>.

Si quieres asegurar tu API, hay varias cosas mejores que puedes hacer, por ejemplo:

/**
 * Admin action for Synonym management.
 *
 */
public class AdminDictSynonymAction extends FessAdminAction {

    /**
     * Role name required for accessing synonym dictionary administration features.
     */
    public static final String ROLE = "admin-dict";

    private static final Logger logger = LogManager.getLogger(AdminDictSynonymAction.class);

@SuppressWarnings("JUnit4ClassUsedInJUnit3")
public class ListSubListTester<E> extends AbstractListTester<E> {
  public void testSubList_startNegative() {
    assertThrows(IndexOutOfBoundsException.class, () -> getList().subList(-1, 0));
  }

  public void testSubList_endTooLarge() {
    assertThrows(IndexOutOfBoundsException.class, () -> getList().subList(0, getNumElements() + 1));
  }

@SuppressWarnings("JUnit4ClassUsedInJUnit3")
public class ListSubListTester<E> extends AbstractListTester<E> {
  public void testSubList_startNegative() {
    assertThrows(IndexOutOfBoundsException.class, () -> getList().subList(-1, 0));
  }

  public void testSubList_endTooLarge() {
    assertThrows(IndexOutOfBoundsException.class, () -> getList().subList(0, getNumElements() + 1));
  }

import org.opensearch.search.sort.SortOrder;

/**
 * Command class for handling term query execution and conversion.
 * This class processes Lucene TermQuery objects and converts them to OpenSearch QueryBuilder instances.
 */
public class TermQueryCommand extends QueryCommand {
    private static final Logger logger = LogManager.getLogger(TermQueryCommand.class);

    /**
     * Default constructor for TermQueryCommand.
     */

import jcifs.NameServiceClient;
import jcifs.NetbiosAddress;
import jcifs.smb.NtlmPasswordAuthentication;

/**
 * JUnit 5 tests for the NtlmSsp class.
 * This class uses Mockito to simulate HttpServletRequest and HttpServletResponse objects.
 */
@ExtendWith(MockitoExtension.class)
public class NtlmSspTest {

    @Mock
    private CIFSContext mockCifsContext;

    @Mock
    private Configuration mockConfig;

    @Mock

这部分文档在 `/docs` 下的 Swagger API 文档中显示，并且会告诉外部开发者如何构建*外部 API*。

本例没有实现回调本身（只是一行代码），只有文档部分。

/// tip | 提示

实际的回调只是 HTTP 请求。

实现回调时，要使用 <a href="https://www.encode.io/httpx/" class="external-link" target="_blank">HTTPX</a> 或 <a href="https://requests.readthedocs.io/" class="external-link" target="_blank">Requests</a>。

///

## 编写回调文档代码

应用不执行这部分代码，只是用它来*记录 外部 API* 。

但，您已经知道用 **FastAPI** 创建自动 API 文档有多简单了。

  @GwtIncompatible @J2ktIncompatible private static final long serialVersionUID = 0;

  private static final class BelowAll extends Cut<Comparable<?>> {
    private static final BelowAll INSTANCE = new BelowAll();

    private BelowAll() {
      /*
       * No code ever sees this bogus value for `endpoint`: This class overrides both methods that

import jakarta.annotation.PostConstruct;

/**
 * Helper class for managing related content configurations.
 * This class provides functionality to load, cache, and retrieve related content
 * based on search queries and virtual host configurations. It supports both exact
 * term matching and regex pattern matching for flexible content association.
 */
public class RelatedContentHelper extends AbstractConfigHelper {

    /**