Skip to content

Commit eca0778

Browse files
committed
writing: improve wording of 'what is a rest api' lecture
1 parent e8e7c6a commit eca0778

File tree

1 file changed

+7
-3
lines changed
  • docs/docs/01_course_intro/04_what_is_rest_api

1 file changed

+7
-3
lines changed

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ That data might look like this:
6262

6363
### The purpose of APIs
6464

65-
Okay, we've learned that we can make a Flask app and expose certain functions to the public by using endpoints. Clients can then make requests (we'll learn how later), and get data.
65+
We've learned that we can make a Flask app and expose certain functions to the public by using endpoints. Clients can then make requests (we'll learn how later), and get data.
6666

67-
Clients can also send data, which the functions can use.
67+
Clients can also send data, which the Flask functions can use.
6868

6969
But _why_? If you want to use certain functions, why not just code them in your application?
7070

@@ -74,10 +74,14 @@ Let's say you want to build a weather app.
7474

7575
You could try to install sensors at the top of your house, connect them directly to the computer running your code, and then offer weather info based on what the sensors say...
7676

77-
Or you could request weather data from the OpenWeatherMap API, just as tens of thousands of other devices do.
77+
Or you could request weather data from the OpenWeatherMap API, just as tens of thousands of other devices do.
7878

7979
Much easier, and all you have to do is make a request to the API!
8080

81+
### What is a client?
82+
83+
An API client can be any device, such as a web app or a mobile app.
84+
8185
### Making an API for your own consumption
8286

8387
Make software companies make APIs that only they use (so they aren't fully public).

0 commit comments

Comments
 (0)