 |
Overview | Spell Check API | Binary Math |
APIs in this Sub Menu
HTML, CSS, and JavaScript are the front-end of the API. Python and API resource definitions are used for RESTful API definitions. Abstraction of Frontend and Backend code, the exchange of standard data format (JSON), and guidelines for exchange (REST) is a technique that saves a lot of time between developers. Learning APIs is a highly recommended step for every developer trying to break into the world of tech.
- Covid19: RapidAPI example. This is introducing APIs by accessing something that already exists. RapidAPI shows how many practice RESTful definitions. Almost any data source imagined can be accessed here.
- Jokes: An introduction to Python RESTful API libraries. A Python List is used to make a Data Model, but persistence in this technique is limited, each time server is refreshed data is lost. This example is great for learning, but data is considered volatile.
- Users: Another RESTful API library example. However, this backend establishes data persistence through the use of a database. This data if properly managed in deployment and migrated when changed can last forever.
Web API Overview
A Web API is an application programming interface typically for a web browser. Non-changing or Static Endpoints are used in interacting with the server-side Web APIs. RESTful Web APIs use HTTP methods to access resources via URL parameters, and use JSON for transmitting text between client and server.
- Server. In these examples, we will be using Python to define REST APIs. Python tools are very popular for building RESTful APIs
- REST: Representational State Transfer. A set of guidelines on how to architect a network-connected software system.
- Client-server: One guideline is a client and server must be decoupled from each other, allowing each to develop independently.
- Layered system: The client may access the resources on the server indirectly through other layers such as a proxy or using authentication. This will be clarified by application and security requirements.
- Client. JavaScript is the frontend language used to consume data from the Python defined REST APIs. Fetch will be used to make HTTP requests, as well as handle HTTP response. There are four basic HTTP methods, they align with Create, Read, Update, Delete (CRUD).
- GET => Retrieve/Read data
- POST => Create data
- PUT => Update data
- DELETE => Delete data
- REST endpoints will have similarity from application to application. In planning APIs, for a Users system you can anticipate key methods. The Users RESTful APIs would likely contain these endpoints.
- GET: /users => Get a list of users
- GET: /users(id) => Get a single user
- POST: /users => Create a new user
- PUT: /users(id) => Update a user
- DELETE: /users(id) => Delete a user
- Once a RESTful API receives and processes an HTTP request, it will return an HTTP response. Included in this response is an HTTP status code. Common status codes are shown.
- 200 => OK, this response will then have the promise of JSON data
- 400 => Bad Request
- 404 => Not Found
- 500 => Internal Server Error (aka bug)