[TUTORIAL] APIs, REST and RESTful APIs.#303
[TUTORIAL] APIs, REST and RESTful APIs.#303Adi-ti09 wants to merge 10 commits intosodafoundation:masterfrom
Conversation
Update readme.md
Update readme.md
Update readme.md
Adi-ti09
changed the title
anvithks
left a comment
anvithks
left a comment
There was a problem hiding this comment.
Good job @Adi-ti09 @AachalG @anupriyajaiswal13 @Anupama-19 .
Please check the review comments and update.
| # How to use an API? | ||
| #### The steps to implement a new API include: | ||
|
|
||
| - Obtaining an API key. This is done by creating a verified account with the API provider. |
There was a problem hiding this comment.
Is this step specific to some API provider?
There was a problem hiding this comment.
No Sir. These are general instructions. The user can choose an API based on their needs. For any API provider, the user creates an account with them and further obtains an API key.
|
|
||
| - Set up an HTTP API client. This tool allows you to structure API requests easily using the API keys received. | ||
|
|
||
| - If you don’t have an API client, you can try to structure the request yourself in your browser by referring to the API documentation. |
There was a problem hiding this comment.
Which service is being used as a reference here?
Preferably use an open source service that allows public access to APIs
There was a problem hiding this comment.
The steps mentioned are general steps that can be applied to any API. There is no specific service being referenced here. Many open source services allow public access to APIs, such as OpenWeatherMap, Twitter API, GitHub API, and Google Maps API. Should we mention all these public APIs as examples?
| - The response body contains the resource representation. The server selects an appropriate representation format based on what the request headers contain. | ||
| - Clients can request information in XML or JSON formats, which define how the data is written in plain text. For example, if the client requests the name and age of a person named John, the server returns a JSON representation as follows: | ||
|
|
||
| '{"name":"John", "age":30}' |
There was a problem hiding this comment.
You can use a code block to display json.
{
"name" : "John",
"age" : 30
}|
|
||
| - They give more context about the response and include information such as the server, encoding, date, and content type. | ||
|
|
||
| ### References: |
There was a problem hiding this comment.
Please provide the links to the documents where the content is sourced from to ensure proper references are given.
5 participants
This is a documentation by Group 3. This pr contains:
-What is API
-What is REST
-What are the benefits of RESTfuk APIs
-How do RESTful APIs work
-Client Request
-Authentication methods
-Server Response