ruidy/fastapi
1
0
Fork 0
mirror of https://github.com/rjNemo/fastapi synced 2026-06-11 13:06:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

📝 Update docs to improve look in GitHub

Browse source
This commit is contained in:
Sebastián Ramírez 2018-12-21 16:32:09 +04:00
parent 16f6dc66e2
commit a0628f3f6f
2 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -65,6 +65,8 @@ $ pip install uvicorn
## Example ## Example
### Create it
* Create a file `main.py` with: * Create a file `main.py` with:
```Python ```Python
@ -109,7 +111,9 @@ If you don't know, check the _"In a hurry?"_ section about <a href="https://fast
</details> </details>
* Run the server with: ### Run it
Run the server with:
```bash ```bash
uvicorn main:app --debug uvicorn main:app --debug
@ -139,9 +143,9 @@ You will see the JSON response as:
You already created an API that: You already created an API that:
* Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`. * Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.
* Both _paths_ take `GET` <abbr title="also known as HTTP methods"><em>operations</em></abbr>. * Both _paths_ take `GET` <em>operations</em> (also known as HTTP _methods_).
* The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`. * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.
* The _path_ `/items/{item_id}` has an optional _query parameter_ `q` that is a `str`. * The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.
### Interactive API docs ### Interactive API docs

10
docs/index.md
View file

@ -65,6 +65,8 @@ $ pip install uvicorn
## Example ## Example
### Create it
* Create a file `main.py` with: * Create a file `main.py` with:
```Python ```Python
@ -109,7 +111,9 @@ If you don't know, check the _"In a hurry?"_ section about <a href="https://fast
</details> </details>
* Run the server with: ### Run it
Run the server with:
```bash ```bash
uvicorn main:app --debug uvicorn main:app --debug
@ -139,9 +143,9 @@ You will see the JSON response as:
You already created an API that: You already created an API that:
* Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`. * Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.
* Both _paths_ take `GET` <abbr title="also known as HTTP methods"><em>operations</em></abbr>. * Both _paths_ take `GET` <em>operations</em> (also known as HTTP _methods_).
* The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`. * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.
* The _path_ `/items/{item_id}` has an optional _query parameter_ `q` that is a `str`. * The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.
### Interactive API docs ### Interactive API docs