Skip to content

Commit ec3090b

Browse files
authored
Merge branch 'develop' into patch-1
2 parents 32e0264 + 998635f commit ec3090b

File tree

197 files changed

+382
-274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

197 files changed

+382
-274
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"githubPullRequests.ignoredPullRequestBranches": [
3+
"develop"
4+
]
5+
}

docs/docs/01_course_intro/01_curriculum_overview/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/docs/01_course_intro/02_how_to_install_python/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: How to install Python
33
description: A brief description of the lecture goes here.
4+
ctslug: how-to-install-python
45
---
56

67
# How to install Python on your computer
@@ -25,7 +26,7 @@ If you have multiple versions of Python installed, such as a version you install
2526
C:\\Users\\yourname\\AppData\\Local\\Programs\\Python\\Python39-32\\python.exe
2627
```
2728

28-
When you use an IDE, such as [Visual Studio Code](../how_to_install_ide), you can use the integrated terminal instead of `cmd.exe`.
29+
When you use an IDE, such as [Visual Studio Code](../how_to_install_ide/), you can use the integrated terminal instead of `cmd.exe`.
2930

3031
## On Mac
3132

docs/docs/01_course_intro/03_how_to_install_ide/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: How to install an IDE
33
description: What IDE should you use? How do you install it? Let me show you in this quick guide.
4+
ctslug: how-to-install-an-ide
45
---
56

67
# How to install an IDE

docs/docs/01_course_intro/04_what_is_rest_api/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "What is a REST API?"
33
description: "There's a lot of confusion around what is and isn't a REST API. Let's take a look!"
4+
ctslug: what-is-an-rest-api
45
---
56

67
# What is a REST API?
@@ -151,11 +152,11 @@ We'll deal with user authentication in a later section, but that's what the lock
151152

152153
### Stores
153154

154-
| Method | Endpoint | Description |
155-
| ------ | ------------- | ---------------------------------------- |
156-
| `GET` | `/store` | Get a list of all stores. |
157-
| `POST` | `/store` | Create a store. |
158-
| `GET` | `/store/{id}` | Get a single store, given its unique id. |
155+
| Method | Endpoint | Description |
156+
| -------- | ------------- | ---------------------------------------- |
157+
| `GET` | `/store` | Get a list of all stores. |
158+
| `POST` | `/store` | Create a store. |
159+
| `GET` | `/store/{id}` | Get a single store, given its unique id. |
159160
| `DELETE` | `/store/{id}` | Delete a store, given its unique id. |
160161

161162
### Items

docs/docs/03_first_rest_api/01_project_overview/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Project Overview
33
description: A first look at the project we'll build in this section.
4+
ctslug: overview-of-your-first-rest-api
45
---
56

67
# Overview of your first REST API

docs/docs/03_first_rest_api/02_getting_set_up/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Getting set up
33
description: Set up a Flask project and create the Flask app.
4+
ctslug: getting-set-up
45
---
56

67
# Getting set up

docs/docs/03_first_rest_api/03_first_rest_api_endpoint/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Your First REST API Endpoint
33
description: Learn how to define a REST API endpoint using Flask.
4+
ctslug: your-first-rest-api-endpoint
45
---
56

67
# Your First REST API Endpoint

docs/docs/03_first_rest_api/04_what_is_json/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "What is JSON?"
33
description: JSON is the way we normally transfer data to and from REST APIs.
4+
ctslug: what-is-json
45
---
56

67
# What is JSON?

docs/docs/03_first_rest_api/05_make_request_to_rest_api/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: How to interact with your REST API
33
description: Use Postman and Insomnia REST Client to interact with your REST API.
4+
ctslug: how-to-interact-with-your-rest-api
45
---
56

67
# How to make a request to a REST API
@@ -28,11 +29,11 @@ Start by [downloading Insomnia REST Client](https://insomnia.rest/).
2829

2930
Once you've opened it, create a Project. I would call it "REST APIs with Flask and Python".
3031

31-
![Creating the Project for this course](assets/creating-project.png)
32+
![Creating the Project for this course](https://res.cloudinary.com/teclado/image/upload/v1689180715/courses/rest-apis-flask-python/creating-project_qsyxlg.png)
3233

3334
Then, create a new Request Collection. Call it "Stores REST API".
3435

35-
![Creating the Stores REST API Request Collection](assets/making-request-collection.png)
36+
![Creating the Stores REST API Request Collection](https://res.cloudinary.com/teclado/image/upload/v1689180710/courses/rest-apis-flask-python/making-request-collection_lcthlv.png)
3637

3738
In the Request Collection, we can now add requests! Each request has a few parts:
3839

@@ -45,19 +46,19 @@ Let's create our first request, `GET /store`.
4546

4647
Make a new request using the Insomnia interface. First, use the dropdown to start:
4748

48-
![How to make a request using the Insomnia interface](assets/making-request.png)
49+
![How to make a request using the Insomnia interface](https://res.cloudinary.com/teclado/image/upload/v1689180711/courses/rest-apis-flask-python/making-request_hmiptl.png)
4950

5051
Then enter the request name. Leave the method as `GET`:
5152

52-
![Enter the request name and method](assets/set-request-name-and-method.png)
53+
![Enter the request name and method](https://res.cloudinary.com/teclado/image/upload/v1689180712/courses/rest-apis-flask-python/set-request-name-and-method_bc6smy.png)
5354

5455
Once you're done, you will see your request in the collection:
5556

56-
![The request is shown in the collection](assets/before-setting-url.png)
57+
![The request is shown in the collection](https://res.cloudinary.com/teclado/image/upload/v1689180711/courses/rest-apis-flask-python/before-setting-url_qjxvyr.png)
5758

5859
Next up, enter the URL for your request. Here we will be requesting the `/store` endpoint. Remember to include your Base URL as well:
5960

60-
![Entering the full URL for the request in Insomnia](assets/url-set.png)
61+
![Entering the full URL for the request in Insomnia](https://res.cloudinary.com/teclado/image/upload/v1689180714/courses/rest-apis-flask-python/url-set_fgp9s9.png)
6162

6263
Once you're done, make sure that your Flask app is running! If it isn't, remember to activate your virtual environment first and then run the app:
6364

@@ -74,6 +75,6 @@ If you get an error, read it carefully and make sure that no other Flask app is
7475

7576
Once your Flask app is running, you can hit "Send" on the Insomnia client, and you should see the JSON come back from your API!
7677

77-
![Making a request to our API using Insomnia](assets/after-pressing-send.png)
78+
![Making a request to our API using Insomnia](https://res.cloudinary.com/teclado/image/upload/v1689180712/courses/rest-apis-flask-python/after-pressing-send_okjkjq.png)
7879

7980
If that worked and you can see your JSON, you're good to go! You've made your first API request. Now we can continue developing our REST API, remembering to always create new Requests in Insomnia and test our code as we go along!

0 commit comments

Comments
 (0)