mirror of https://github.com/tiangolo/fastapi.git
📝 Fix docstring of `servers` parameter (#14405)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
parent
c516c9904b
commit
dcf0299195
|
|
@ -443,6 +443,14 @@ The docs UI will interact with the server that you select.
|
|||
|
||||
///
|
||||
|
||||
/// note | Technical Details
|
||||
|
||||
The `servers` property in the OpenAPI specification is optional.
|
||||
|
||||
If you don't specify the `servers` parameter and `root_path` is equal to `/`, the `servers` property in the generated OpenAPI schema will be omitted entirely by default, which is the equivalent of a single server with a `url` value of `/`.
|
||||
|
||||
///
|
||||
|
||||
### Disable automatic server from `root_path` { #disable-automatic-server-from-root-path }
|
||||
|
||||
If you don't want **FastAPI** to include an automatic server using the `root_path`, you can use the parameter `root_path_in_servers=False`:
|
||||
|
|
|
|||
|
|
@ -301,7 +301,12 @@ class FastAPI(Starlette):
|
|||
browser tabs open). Or if you want to leave fixed the possible URLs.
|
||||
|
||||
If the servers `list` is not provided, or is an empty `list`, the
|
||||
default value would be a `dict` with a `url` value of `/`.
|
||||
`servers` property in the generated OpenAPI will be:
|
||||
|
||||
* a `dict` with a `url` value of the application's mounting point
|
||||
(`root_path`) if it's different from `/`.
|
||||
* otherwise, the `servers` property will be omitted from the OpenAPI
|
||||
schema.
|
||||
|
||||
Each item in the `list` is a `dict` containing:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue