*/
    protected enum FormatType {
        /** Search API format. */
        SEARCH,
        /** Label API format. */
        LABEL,
        /** Popular word API format. */
        POPULARWORD,
        /** Favorite API format. */
        FAVORITE,
        /** Favorites API format. */
        FAVORITES,
        /** Ping API format. */
        PING,
        /** Scroll API format. */

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

![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

### Alternative API docs { #alternative-api-docs }

And now, go to [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).

 * ⬜️ [Okio](https://github.com/square/okio/): A modern I/O API for Java.
 * [OkLog](https://github.com/simonpercic/OkLog): Response logging interceptor for OkHttp. Logs a URL link with URL-encoded response for every OkHttp call.
 * [Okurl](https://github.com/yschimke/okurl/wiki) A curl-like client for social networks and other APIs.

- **Package**: `org.codelibs.curl.*`

## Code Style

- Uses external Eclipse formatter from CodeLibs
- Apache License 2.0 headers on all source files
- Comprehensive Javadoc on public APIs

## Test Conventions

- Test class names end with `Test`
- Test methods start with `test_` prefix
- Tests use `## Arrange ##`, `## Act ##`, `## Assert ##` comments
- Some integration tests require network access

   *   <li>{@link #JAVA_COMPILER}, while still listed as required as of Java 15, is typically not
   *       available even under older version.
   *   <li>Any property may be cleared through APIs like {@link System#clearProperty}.
   *   <li>Unusual environments like GWT may have their own special handling of system properties.
   * </ul>
   *

## Decision

Organize the Gradle code base into a set of coarse-grained "architecture modules".
An architecture module is responsible for providing a coherent set of features and:

- Provides a set of APIs and services for use from outside the module.
- Has a private implementation.
- Is owned by a single team. A team may own multiple architecture modules.

The modules are arranged into several different "Gradle platforms".

            if (stage.specificBuilds.contains(SpecificBuild.SanityCheck)) {
                buildReportTab(
                    "API Compatibility Report",
                    "$HIDDEN_ARTIFACT_DESTINATION/report-architecture-test-binary-compatibility-report.html",
                )
                buildReportTab("Incubating APIs Report", "incubation-reports/all-incubating.html")
            }
            if (stage.performanceTests.isNotEmpty()) {

   *   <li>{@link #JAVA_COMPILER}, while still listed as required as of Java 15, is typically not
   *       available even under older version.
   *   <li>Any property may be cleared through APIs like {@link System#clearProperty}.
   *   <li>Unusual environments like GWT may have their own special handling of system properties.
   * </ul>
   *

import com.fasterxml.jackson.databind.node.ObjectNode;
import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputFile;
import org.gradle.api.tasks.TaskAction;
import org.gradle.work.ChangeType;
import org.gradle.work.Incremental;

---
name: fastapi
description: FastAPI best practices and conventions. Use when working with FastAPI APIs and Pydantic models for them. Keeps FastAPI code clean and up to date with the latest features and patterns, updated with new versions. Write new code or refactor and update old code.
---

# FastAPI

Official FastAPI skill to write code with best practices, keeping up to date with new versions and features.

## Use the `fastapi` CLI