> For the complete documentation index, see [llms.txt](https://ios-course.cornellappdev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ios-course.cornellappdev.com/resources/tool-guides/postman.md).

# Postman

Postman is an API platform used by developers to test API calls. It is a powerful tool that we can use to build and design APIs.

### Installation

You can download Postman [here](https://www.postman.com/). Once it’s installed, create an account.

### Getting Started

1. To get started, create a **Blank Workspace.** Give it a name and set the access scope to whatever you like.

<figure><img src="/files/pnwSdyDabE9rSAwu1FSK" alt=""><figcaption></figcaption></figure>

2. Make sure the **Collections** tab is selected, then click the `+` button to create a new collection.

<figure><img src="/files/Tl7BJkDr9PwWK63ZtF69" alt=""><figcaption></figcaption></figure>

2. To add requests to this collection, click on the `+` .

<figure><img src="/files/vDBoZ3EOSg6RsdjGG3CN" alt=""><figcaption></figcaption></figure>

### Creating a Request

1. Click on the `+` next in the tab.
2. Give it any name you want.
3. Select the request type: GET, POST, etc.
4. Enter the endpoint URL.
5. (Optional) Provide a request body or input query parameters.
   1. For the request body, select **Body > Raw > JSON**. Then input body parameters in JSON format.
6. Click send to send the request

### Examples

#### GET Request&#x20;

* URL Link is deprecated, but you can follow the same procedure with the assignment 3 [A3: ChatDev](/resources/archived-past-semesters/fa25/assignments/a3-chatdev.md#part-iii-fetching-posts)

```
## fetch
GET: https://ios-course-backend.cornellappdev.com/api/posts/

## make a post
POST: https://ios-course-backend.cornellappdev.com/api/posts/create/

## like a post
POST: https://ios-course-backend.cornellappdev.com/api/posts/{postId}/like/
```

Let’s fetch the FA23 AppDev Roster: <https://ioscourse-g3jtiqqehq-ue.a.run.app>

<figure><img src="/files/S0CL6BtbVRDIxDlzTZJB" alt=""><figcaption></figcaption></figure>

This is a GET request that does not take in any query parameters or request body. You can also see the status of the request (”200 OK”).

#### POST Request

Let’s add a new member to the roster:<https://ioscourse-g3jtiqqehq-ue.a.run.app>

<figure><img src="/files/Bip8vCnbXdzuRdkFFUQG" alt=""><figcaption></figcaption></figure>

This is a POST request that takes in a request body in the above JSON format. The server responds with a 200 status code and the member that we added.

If we tried to provide an invalid request, then the server responds with a 400 Bad Request status code and an error message.

<figure><img src="/files/Qb5W99lIcx87CWpzTcS6" alt=""><figcaption></figcaption></figure>