{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

## `examples` in JSON Schema - OpenAPI { #examples-in-json-schema-openapi }

When using any of:

* `Path()`
* `Query()`
* `Header()`
* `Cookie()`
* `Body()`
* `Form()`
* `File()`

you can also declare a group of `examples` with additional information that will be added to their **JSON Schemas** inside of **OpenAPI**.

from typing import Annotated

from fastapi import Depends, FastAPI, HTTPException, Query
from sqlmodel import Field, Session, SQLModel, create_engine, select


class HeroBase(SQLModel):
    name: str = Field(index=True)
    age: int | None = Field(default=None, index=True)


class Hero(HeroBase, table=True):
    id: int | None = Field(default=None, primary_key=True)
    secret_name: str


class HeroPublic(HeroBase):
    id: int

    assert response.status_code == 422, response.text
    assert response.json() == snapshot(
        {
            "detail": [
                {
                    "type": "value_error",
                    "loc": ["query", "id"],
                    "msg": 'Value error, Invalid ID format, it must start with "isbn-" or "imdb-"',
                    "input": "wtf-yes",
                    "ctx": {"error": {}},
                }
            ]

    assertThat(effectivePort, "port").isEqualTo(testData.port)
    assertThat(url.encodedPath, "path").isEqualTo(testData.path)
    assertThat(effectiveQuery, "query").isEqualTo(testData.query)
    assertThat(effectiveFragment, "fragment").isEqualTo(testData.fragment)
  }

  companion object {
    private val HTTP_URL_SCHEMES = listOf("http", "https")
    private val KNOWN_FAILURES =

<%@page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%>
<%-- query did not match any document --%>
<div id="result" class="row">
	<div class="col-md-8 alert alert-info">
		<la:message key="labels.did_not_match" arg0="${displayQuery}" />
	</div>
	<div class="col-md-4"><%-- Side Content --%></div>

    public PopularWordsRequestBuilder addExcludeWord(final String excludeWord) {
        request.addExcludeWord(excludeWord);
        return this;
    }

    /**
     * Sets the query frequency threshold.
     * @param queryFreqThreshold The query frequency threshold.
     * @return This builder instance.
     */
    public PopularWordsRequestBuilder setQueryFreqThreshold(final int queryFreqThreshold) {

    }

    /**
     * Gets a cached facet response for the given query.
     * Creates and caches the response if not already cached.
     *
     * @param query the search query
     * @return the facet response
     * @throws FessSystemException if facet data cannot be loaded
     */
    public FacetResponse getCachedFacetResponse(final String query) {

这些额外的信息将按原样添加到输出的JSON模式中。

## `Field` 的附加参数

在 `Field`, `Path`, `Query`, `Body` 和其他你之后将会看到的工厂函数，你可以为JSON 模式声明额外信息，你也可以通过给工厂函数传递其他的任意参数来给JSON 模式声明额外信息，比如增加 `example`:

{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

/// warning

请记住，传递的那些额外参数不会添加任何验证，只会添加注释，用于文档的目的。

///

## `Body` 额外参数

你可以通过传递额外信息给 `Field` 同样的方式操作`Path`, `Query`, `Body`等。

比如，你可以将请求体的一个 `example` 传递给 `Body`:

<%@page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%>
<script src="${fe:url('/js/admin/jquery-3.7.1.min.js')}" type="text/javascript"></script>
<script src="${fe:url('/js/admin/popper.min.js')}" type="text/javascript"></script>
<script src="${fe:url('/js/admin/bootstrap.min.js')}" type="text/javascript"></script>
<script src="${fe:url('/js/admin/moment-with-locales.min.js')}" type="text/javascript"></script>

          assertEquals(
              ImmutableList.copyOf(asMap.entrySet()).reverse(),
              ImmutableList.copyOf(descendingMap.entrySet()));

          for (Range<Integer> query : RANGES) {
            assertEquals(expectedAsMap.get(query), asMap.get(query));
          }
        }
      }
    }
  }


  public void testSubRangeMap() {
    for (Range<Integer> range1 : RANGES) {