FastAPI从入门到实战（3）——Hello World（安装与运行）

我不是女神ヾ 2024-03-31 12:25 44阅读 0赞

> 本文详细记录FastAPI本地的安装和运行，都很简单，主要记录验证一些特性。

### 安装FastAPI ###

安装就非常简单，只需要安装两个包就行：

*  FastAPI

pip install fastapi

*  uvicorn——用于加载和提供应用程序的服务器。

pip install uvicorn

### 创建项目 ###

*  在pycharm 2022版里面可以直接创建FastAPI项目，不知道其他版本可不可以，直接创建就行；

![7430f6eadd79fac8a0c98a6909e63be2.png][]

> 如果没有的话也不要慌，创建一个空项目就行。
> 
> 在main.py文件内粘贴如下代码就行：
> 
>     from fastapi import FastAPI
>     
>     app = FastAPI()
>     
>     @app.get("/")
>     async def root():
>         return {
>          "message": "Hello World"}

*  运行项目
    
    第一种就是pycharm创建的项目，直接运行就行
    
    ![image-20221123173532349][]
    
    还有一种就是直接创建的，在终端输入运行命令`uvicorn main:app --reload`即可
    
    ![image-20221123173650460][]
 *  查看运行效果：http://127.0.0.1:8000/

![image-20221123173830594][]

输出JSON数据，就搭建成功了。

### 交互式API文档 ###

打开http://127.0.0.1:8000/docs就能看到自动生成的交互式 API 文档（由 [Swagger UI][] 提供）：

![image-20221123174001972][]

### 可选的API文档 ###

前往http://127.0.0.1:8000/redoc就能看到可选的自动生成文档 （由 [ReDoc][] 提供)：

![image-20221123174154120][]

### 源码解析 ###

from fastapi import FastAPI

> 导入fastapi的包

app = FastAPI()

> 创建一个FastAPI实例
> 
> 这里的变量 app 会是 FastAPI 类的一个「实例」。
> 
> 这个实例将是创建你所有 API 的主要交互对象。
> 
> 这个 app 同样在命令中被 uvicorn 所引用：`uvicorn main:app --reload`

@app.get("/")

> 告诉 **FastAPI** 在它下方的函数负责处理如下访问请求：
> 
>  *  路径为`/`
>  *  使用`get`请求方法
> 
> @something 语法在 Python 中被称为「装饰器」，装饰器接收位于其下方的函数并且用它完成一些工作。
> 
> 常见的路径操作装饰器：
> 
>     @app.post("/")
>     @app.put("/")
>     @app.delete("/")
>     @app.get("/")
>     @app.options("/")
>     @app.head("/")
>     @app.patch("/")
>     @app.trace("/")
>     async def root():
>         return {
>          "message": "Hello World"}

async def root():
        return {
        "message": "Hello World"}

> `async`定义一个异步的函数，每次请求`/`都会被调用，并返回`{"message": "Hello World"}`

### 配置项 ###

主要是一些基本的配置项，比如两个API地址的访问地址，文档标题与简介等。这些就可以直接看源码：

class FastAPI(Starlette):
        def __init__(
            self,
            *,
            debug: bool = False,
            routes: Optional[List[BaseRoute]] = None,
            title: str = "FastAPI",
            description: str = "",
            version: str = "0.1.0",
            openapi_url: Optional[str] = "/openapi.json",
            openapi_tags: Optional[List[Dict[str, Any]]] = None,
            servers: Optional[List[Dict[str, Union[str, Any]]]] = None,
            dependencies: Optional[Sequence[Depends]] = None,
            default_response_class: Type[Response] = Default(JSONResponse),
            docs_url: Optional[str] = "/docs",
            redoc_url: Optional[str] = "/redoc",
            swagger_ui_oauth2_redirect_url: Optional[str] = "/docs/oauth2-redirect",
            swagger_ui_init_oauth: Optional[Dict[str, Any]] = None,
            middleware: Optional[Sequence[Middleware]] = None,
            exception_handlers: Optional[
                Dict[
                    Union[int, Type[Exception]],
                    Callable[[Request, Any], Coroutine[Any, Any, Response]],
                ]
            ] = None,
            on_startup: Optional[Sequence[Callable[[], Any]]] = None,
            on_shutdown: Optional[Sequence[Callable[[], Any]]] = None,
            terms_of_service: Optional[str] = None,
            contact: Optional[Dict[str, Union[str, Any]]] = None,
            license_info: Optional[Dict[str, Union[str, Any]]] = None,
            openapi_prefix: str = "",
            root_path: str = "",
            root_path_in_servers: bool = True,
            responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
            callbacks: Optional[List[BaseRoute]] = None,
            deprecated: Optional[bool] = None,
            include_in_schema: bool = True,
            swagger_ui_parameters: Optional[Dict[str, Any]] = None,
            generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
                generate_unique_id
            ),
            **extra: Any,
        )

参数还是比较清晰的，比如是否开启debug模式、标题、简介、版本等等，简单配置如下：

app = FastAPI(
        title='FastAPI Study',
        description='FastAPI教程',
        version='1.0.0',
        docs_url='/docs',
        redoc_url='/redocs',
    )

效果图：

本等等，简单配置如下：

app = FastAPI(
        title='FastAPI Study',
        description='FastAPI教程',
        version='1.0.0',
        docs_url='/docs',
        redoc_url='/redocs',
    )

效果图：

### ![image-20221124161800866][] ###

感谢阅读！  
博客链接：[https://blog.jiumoz.com/archives/fastapi-cong-ru-men-dao-shi-zhan-3helloworld][https_blog.jiumoz.com_archives_fastapi-cong-ru-men-dao-shi-zhan-3helloworld]

![30b7b3ba49344b6691969078c7df196e.png][]欢 迎 关 注 博 主 个 人 小 程 序！

[7430f6eadd79fac8a0c98a6909e63be2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/5b88fbd0f2194ff0bf7a92996c280c99.png
[image-20221123173532349]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/27c095d0cf7941a090d65c880a4c4ed9.png
[image-20221123173650460]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/23da956ca23e4f65932806b753a61093.png
[image-20221123173830594]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/57b6a380b1ff49db98188566ffc52488.png
[Swagger UI]: https://github.com/swagger-api/swagger-ui
[image-20221123174001972]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/66c7f799e87b4e9297c403699642c1d7.png
[ReDoc]: https://github.com/Rebilly/ReDoc
[image-20221123174154120]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/caf0f6481e9a497895f1a38d998ad005.png
[image-20221124161800866]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c7a2a118b9084048a8273570880b9c39.png
[https_blog.jiumoz.com_archives_fastapi-cong-ru-men-dao-shi-zhan-3helloworld]: https://blog.jiumoz.com/archives/fastapi-cong-ru-men-dao-shi-zhan-3helloworld
[30b7b3ba49344b6691969078c7df196e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/df74ed0f5e414442a3396b3a602b73f5.png