///

## OpenAPI and API docs { #openapi-and-api-docs }

If you return additional status codes and responses directly, they won't be included in the OpenAPI schema (the API docs), because FastAPI doesn't have a way to know beforehand what you are going to return.

</blockquote>

## 調研 { #investigation }

透過實際使用這些替代方案，我得以向它們學習、汲取想法，並以我能為自己與合作開發團隊找到的最佳方式加以整合。

例如，很清楚理想上應以標準的 Python 型別提示為基礎。

同時，最佳做法就是採用現有標準。

因此，在開始撰寫 **FastAPI** 之前，我花了好幾個月研究 OpenAPI、JSON Schema、OAuth2 等規範，了解它們之間的關係、重疊與差異。

## 設計 { #design }

接著，我花時間設計作為使用者（作為使用 FastAPI 的開發者）時希望擁有的開發者「API」。

我在最受歡迎的 Python 編輯器中測試了多個想法：PyCharm、VS Code、基於 Jedi 的編輯器。

                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                    }
                }
            },
        }

                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "security": [{"HTTPBearer": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {"HTTPBearer": {"type": "http", "scheme": "bearer"}}
            },
        }

}

// SetupJoinTable setup join table schema
func (db *DB) SetupJoinTable(model interface{}, field string, joinTable interface{}) error {
	var (
		tx                      = db.getInstance()
		stmt                    = tx.Statement
		modelSchema, joinSchema *schema.Schema
	)

	err := stmt.Parse(model)
	if err != nil {
		return err
	}
	modelSchema = stmt.Schema

	err = stmt.Parse(joinTable)

#  limitations under the License.
#

# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: Feature request
description: File a proposal for new feature, improvement
labels: ["enhancement"]

body:
  - type: markdown
    attributes:
      value: |

### [Pydantic](https://docs.pydantic.dev/) { #pydantic }

Pydantic 是基於 Python 型別提示，定義資料驗證、序列化與文件（使用 JSON Schema）的函式庫。

這讓它非常直覺。

它可與 Marshmallow 相提並論。儘管在效能測試中它比 Marshmallow 更快。而且因為它基於相同的 Python 型別提示，編輯器支援也很出色。

/// check | **FastAPI** 用於

處理所有資料驗證、資料序列化與自動模型文件（基於 JSON Schema）。

**FastAPI** 接著會把這些 JSON Schema 資料放入 OpenAPI 中，此外還有其他許多功能。

///

### [Starlette](https://www.starlette.dev/) { #starlette }

<?xml version="1.0" encoding="UTF-8" ?>
<eef>
	<config Schema="2.0" EnterpriseVersion="'7.6.50'">
		<collections Count="3">
			<collection Name="fess">
				<bad_urls><![CDATA[
https://fess.codelibs.org/images/
              ]]></bad_urls>
				<good_urls><![CDATA[
https://fess.codelibs.org/
https://www.codelibs.org/
              ]]></good_urls>
				<prerequisite_results><![CDATA[
20
              ]]></prerequisite_results>

import java.net.URI;
import java.util.Map;
import java.util.stream.Collectors;
import javax.inject.Inject;

/**
 * Performs additional checks on changelog files, beyond whether they conform to the schema.
 */
public class ValidateChangelogEntryTask extends DefaultTask {
    private final ConfigurableFileCollection changelogs;
    private final ProjectLayout projectLayout;

    @Inject

    return {"scheme": credentials.scheme, "credentials": credentials.credentials}


client = TestClient(app)


def test_security_http_bearer():
    response = client.get("/users/me", headers={"Authorization": "Bearer foobar"})
    assert response.status_code == 200, response.text
    assert response.json() == {"scheme": "Bearer", "credentials": "foobar"}