# Unit 5: Hello World! Let's create a new `main.py` file and insert the following code into it: {% code lineNumbers="true" %} ```python from fastapi import FastAPI app = FastAPI() @app.get("/") async def root(): return {"message": "Hello World"} @app.get("/hello/{name}") async def say_hello(name: str): return {"message": f"Hello {name}"} ``` {% endcode %} To run the above program, open a CMD/Terminal and execute the command below: ``` uvicorn main:app --reload --port 8080 ``` The command `uvicorn main:app` refers to: * `main`: the file `main.py` (the Python "module"). * `app`: the object created inside of `main.py` with the line `app = FastAPI()`. * `--reload`: make the server restart after code changes. Only use for development. * `--port 8080`: (optional) used to specifically define the listening port If your program is error-free, below is the result when executing the above command: ``` uvicorn main:app --reload INFO: Will watch for changes in these directories: ['/Users/Dev/Projects/fastApiProject'] INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) INFO: Started reloader process [4079] using WatchFiles INFO: Started server process [4081] INFO: Waiting for application startup. INFO: Application startup complete. ``` Open your browser at `http://127.0.0.1:8000` and you will get a JSON response as: ```json {"message": "Hello World"} ``` To test the `say_hello()` function, change the address to `http://127.0.0.1:8000/hello/` where `` is a variable. *** ## Interactive API docs FastAPI automatically generates an API Docs for your project, provided by [Swagger UI](https://github.com/swagger-api/swagger-ui). The API Docs is available at `http://127.0.0.1:8000/docs`, as shown in Fig. 1.

Fig. 1. An example of API Docs generated by FastAPI, provided by Swagger UI

Besides API Docs provided by Swagger UI, FastAPI also generate another API Docs provided by [ReDoc](https://github.com/Rebilly/ReDoc), available at `http://127.0.0.1:8000/redoc`, as shown in Fig. 2.

Fig. 2. An example of API Docs generated by FastAPI, provided by ReDoc

To ensure compatibility with standard HTTP APIs, FastAPI uses the OpenAPI standard for defining APIs. {% hint style="info" %} The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs. This allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. OpenAPI documents describe API services and are represented in YAML or JSON formats. These documents may be produced and served statically or generated dynamically from an application. {% endhint %} For our Hello World program, you can see `openapi.json` directly at `http://127.0.0.1:8000/openapi.json`. {% code overflow="wrap" %} ```json { "openapi": "3.1.0", "info": { "title": "FastAPI", "version": "0.1.0" }, "paths": { "/": { "get": { "summary": "Root", "operationId": "root__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/hello/{name}": { "get": { "summary": "Say Hello", "operationId": "say_hello_hello__name__get", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } } } } ``` {% endcode %} *** ## Summary The `Hello World` program can best describe the procedure for programming your first APIs with FastAPI, which includes several important steps as follows: 1. Import FastAPI module 2. Create a FastAPI instance, for example, `app = FastAPI()`. You should note that the `app` variable is the same one referred by `uvicorn` in the execution command. 3. Create functions in conjunction with path operations. 1. Path refers to the last part of the URL starting from the first `/`, for example, given an URL as `https://example.com/items/foo`, the path would be `/items/foo`. 2. Operation refers to the HTTP methods such as `POST`, `GET`, `PUT`, `DELETE`. 3. Define a path operation decorator as `@app.get("/")`. The `@app.get("/")` tells FastAPI that the function right below is in charge of handling requests that go to the path `/` using a `GET` operation. 4. Define the path operation function that is specified below the decorator, for example, `async def root()`. 5. Return the content such as a `dict`, `list`, singular values as `str`, `int`, etc. There are many other objects and models that will be automatically converted to JSON (including ORMs, etc). {% hint style="info" %} A "path" is also commonly called an "endpoint" or a "route". {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://fastapi-docs.duonghuuphuc.com/unit-5-hello-world.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.