Skip to content

Commit 124c62c

Browse files
committed
Updated REST API
1 parent 31ceb89 commit 124c62c

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

agenda.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,38 @@
4343

4444
### What is a REST API and why they are now so common
4545

46+
[Good API best practices reference](https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design)
47+
48+
- Why?
49+
- open standard
50+
- simple
51+
- platform independence
52+
- service evolution
53+
- scalable
54+
55+
#### Introduction
56+
An architectural approach to designing web services.
57+
REST is an architectural style for building distributed systems based on hypermedia.
58+
REST is independent of any underlying protocol and is not necessarily tied to HTTP.
59+
However, most common REST implementations use HTTP as the application protocol.
60+
61+
Representational State Transfer (REST) main concepts:
62+
- Resources
63+
- A resource haas an identified
64+
- Interaction with a resource representation
65+
- Uniform interface that uses HTTP verbs
66+
- Stateless (transient, atomic) to enable scalability
67+
- Driven by hypermedia links
68+
69+
Topics to cover:
70+
- Organize the API around resources
71+
- Define operations in terms of HTTP methods
72+
- Media types
73+
- Filter and paginate
74+
- HATEOAS, or Hypertext as the Engine of Application State
75+
- Versioning
76+
- OpenAPI / Swagger
77+
4678
### How to setup a basic API testing/rpa project using the RequestsLibrary
4779
- see README.md
4880
- **🛠️ [hands on]** setup the environment and run selfcheck

0 commit comments

Comments
 (0)