jay/notes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docker file
All checks were successful
Build and Deploy MkDocs / deploy (push) Successful in 10s
Details

Browse Source
This commit is contained in:
John Gatward
2026-03-04 12:07:16 +00:00
parent 455eb65d46
commit e21d76af6a
2 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/books/api_design_patterns/part1/chapter1.md
View File

@@ -1,6 +1,6 @@
# Introduction to APIs # Introduction to APIs
**API**: **A**pplication **P**rogramming **I**nterface **API**: Application Programming Interface
## What are web APIs? ## What are web APIs?
@@ -21,11 +21,12 @@
One of the main reasons is the idea of *statefulness*. One of the main reasons is the idea of *statefulness*.
> **Stateless**: When an API call can be made independently from all other API requests, with no additional context. > - **Stateless**: When an API call can be made independently from all other API requests, with no additional context.
> **Statefulness**: A web API that stores context on a user from previous API requests. > - **Statefulness**: A web API that stores context on a user from previous API requests.
> For example a web API that stores a user's favourite cities and provides weather forecasts for just those has no runtime inputs but requires a state to be set by the user. > For example a web API that stores a user's favourite cities and provides weather forecasts for just those has no runtime inputs but requires a state to be set by the user.
Consider the following API method names: Consider the following API method names:
1. `ScheduleFlight()` 1. `ScheduleFlight()`
2. `GetFlightDetails()` 2. `GetFlightDetails()`
3. `ShowAllFlights()` 3. `ShowAllFlights()`
@@ -39,6 +40,7 @@ Consider the following API method names:
- Was it `ShowFlights()`, `ShowAllFlights()`, `ListFlights()` etc - Was it `ShowFlights()`, `ShowAllFlights()`, `ListFlights()` etc
We need to standardise, by providing a standard set of building blocks - method-resource We need to standardise, by providing a standard set of building blocks - method-resource
1. `CreateFlightReservation()` 1. `CreateFlightReservation()`
2. `GetFlightReservation()` 2. `GetFlightReservation()`
3. `ListFlightReservation()` 3. `ListFlightReservation()`
@@ -51,6 +53,7 @@ We need to standardise, by providing a standard set of building blocks - method-
## What makes an API "good"? ## What makes an API "good"?
What is the purpose of building an API in the first place? What is the purpose of building an API in the first place?
1. We have some functionality that some users want. 1. We have some functionality that some users want.
2. Those users want to use this functionality programmatically 2. Those users want to use this functionality programmatically
@@ -59,7 +62,7 @@ What is the purpose of building an API in the first place?
- The system as a whole must be operational. - The system as a whole must be operational.
- It must do the thing users actually want. - It must do the thing users actually want.
- **Non-operational** requirements: It must perform how the user expects. - **Non-operational** requirements: It must perform how the user expects.
- e.g. like latency - e.g. latency
### Expressive ### Expressive

2
mkdocs.yml
View File

@@ -25,6 +25,8 @@ theme:
- search.suggest - search.suggest
- search.highlight - search.highlight
- search.share - search.share
- content.action.edit
- content.action.view
markdown_extensions: markdown_extensions:
- admonition - admonition