# Generating SDKs { #generating-sdks }

Because **FastAPI** is based on the **OpenAPI** specification, its APIs can be described in a standard format that many tools understand.

This makes it easy to generate up-to-date **documentation**, client libraries (<abbr title="Software Development Kits">**SDKs**</abbr>) in multiple languages, and **testing** or **automation workflows** that stay in sync with your code.

# https://squidfunk.github.io/mkdocs-material/
# It requires Python to run.
# Install the packages with the following command:
# pip install mkdocs mkdocs-material mkdocs-redirects

set -ex

# Test generating the javadoc jars
./gradlew publishToMavenLocal -DRELEASE_SIGNING_ENABLED=false -PokhttpDokka=true

# Generate the API docs
./gradlew dokkaGeneratePublicationHtml -PokhttpDokka=true

mv ./build/dokka/html docs/5.x

 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

plugins {
    `kotlin-dsl`
}

description = "Provides plugin for generating architecture documentation"

group = "gradlebuild"

dependencies {
    implementation(project(":build-environment"))
    implementation(buildLibs.gson)

    /**
     * Queue for thumbnail generation tasks containing URL, content, and path tuples.
     */
    protected BlockingQueue<Tuple3<String, String, String>> thumbnailTaskQueue;

    /**
     * Flag indicating whether thumbnail generation is currently in progress.
     */
    protected volatile boolean generating;

    private Thread thumbnailQueueThread;

    /**

        thumbnailManager = new TestThumbnailManager();
        thumbnailManager.baseDir = tempDir;
        thumbnailManager.thumbnailTaskQueue = new LinkedBlockingQueue<>(100);
        thumbnailManager.generating = false;
    }

    // Test implementation of ThumbnailManager to avoid container dependencies
    private class TestThumbnailManager extends ThumbnailManager {
        @Override
        public void init() {

Taking data from:

* The path as parameters.
* Headers.
* Cookies.
* etc.

And by doing so, **FastAPI** is validating that data, converting it and generating documentation for your API automatically.

But there are situations where you might need to access the `Request` object directly.

## Details about the `Request` object { #details-about-the-request-object }

}
```

## Pydantic `bytes` for Output Data { #pydantic-bytes-for-output-data }

You can also use `bytes` fields with `ser_json_bytes` in the model config for output data, and Pydantic will *serialize* the bytes as base64 when generating the JSON response.

{* ../../docs_src/json_base64_bytes/tutorial001_py310.py ln[1:2,12:16,29,38:41] hl[16] *}

## Pydantic `bytes` for Input and Output Data { #pydantic-bytes-for-input-and-output-data }

    "check that {type_} is a valid Pydantic field type. "
    "If you are using a return type annotation that is not a valid Pydantic "
    "field (e.g. Union[Response, dict, None]) you can disable generating the "
    "response model from the type annotation with the path operation decorator "
    "parameter response_model=None. Read more: "
    "https://fastapi.tiangolo.com/tutorial/response-model/"
)

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.codelibs.core.exception.IORuntimeException;
import org.codelibs.fess.Constants;

/**
 * Utility class for generating and writing thread dumps.
 * Provides methods to capture thread information for debugging purposes.
 */
public class ThreadDumpUtil {
    private static final Logger logger = LogManager.getLogger(ThreadDumpUtil.class);

                // Intent is unclear - ask user for clarification
                phaseStartTime = System.currentTimeMillis();
                callback.onPhaseStart(ChatPhaseCallback.PHASE_ANSWER, "Generating response...");
                llmClientManager.generateUnclearIntentResponse(userMessage, history, (chunk, done) -> {
                    fullResponse.append(chunk);
                    callback.onChunk(chunk, done);