From ad9f3c0d8dbcad2f77ec6ff6ed05fd2f305cae01 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= <tiangolo@gmail.com>
Date: Mon, 10 Dec 2018 08:32:15 +0400
Subject: [PATCH] :memo: Update index/README URLs to be absolute
---
README.md | 16 ++++++++--------
docs/index.md | 16 ++++++++--------
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 3557be2a4..e8e3bec82 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<p align="center">
- <a href="https://fastapi.tiangolo.com"><img style="width: 70%;" src="img/logo-teal-vector.svg" alt='FastAPI'></a>
+ <a href="https://fastapi.tiangolo.com"><img style="width: 70%;" src="https://fastapi.tiangolo.com/img/logo-teal-vector.svg" alt='FastAPI'></a>
</p>
<p align="center">
<em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
@@ -98,7 +98,7 @@ Now go to <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:
You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a>):
-
+
### Alternative API docs
@@ -107,7 +107,7 @@ And now, go to <a href="http://127.0.0.1:8000/redoc" target="_blank">http://127.
You will see the alternative automatic documentation (provided by <a href="https://github.com/Rebilly/ReDoc" target="_blank">ReDoc</a>):
-
+
## Example upgrade
@@ -149,15 +149,15 @@ Now go to <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:
* The interactive API documentation will be automatically updated, including the new query, and body:
-
+
* Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
-
+
* Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
-
+
### Alternative API docs upgrade
@@ -166,7 +166,7 @@ And now, go to <a href="http://127.0.0.1:8000/redoc" target="_blank">http://127.
* The alternative documentation will also reflect the new query parameter and body:
-
+
### Recap
@@ -252,7 +252,7 @@ Try changing the line with:
...and see how your editor will auto-complete the attributes and know their types:
-
+
For a more complete example including more features, [see the tutorial](tutorial).
diff --git a/docs/index.md b/docs/index.md
index 3557be2a4..e8e3bec82 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,5 +1,5 @@
<p align="center">
- <a href="https://fastapi.tiangolo.com"><img style="width: 70%;" src="img/logo-teal-vector.svg" alt='FastAPI'></a>
+ <a href="https://fastapi.tiangolo.com"><img style="width: 70%;" src="https://fastapi.tiangolo.com/img/logo-teal-vector.svg" alt='FastAPI'></a>
</p>
<p align="center">
<em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
@@ -98,7 +98,7 @@ Now go to <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:
You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a>):
-
+
### Alternative API docs
@@ -107,7 +107,7 @@ And now, go to <a href="http://127.0.0.1:8000/redoc" target="_blank">http://127.
You will see the alternative automatic documentation (provided by <a href="https://github.com/Rebilly/ReDoc" target="_blank">ReDoc</a>):
-
+
## Example upgrade
@@ -149,15 +149,15 @@ Now go to <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:
* The interactive API documentation will be automatically updated, including the new query, and body:
-
+
* Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
-
+
* Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
-
+
### Alternative API docs upgrade
@@ -166,7 +166,7 @@ And now, go to <a href="http://127.0.0.1:8000/redoc" target="_blank">http://127.
* The alternative documentation will also reflect the new query parameter and body:
-
+
### Recap
@@ -252,7 +252,7 @@ Try changing the line with:
...and see how your editor will auto-complete the attributes and know their types:
-
+
For a more complete example including more features, [see the tutorial](tutorial).