AW-P-EXEMPLO-1778.postman_collection.json

{
	"info": {
		"_postman_id": "61f156ee-710c-41ca-8f9c-6f07765b98e3",
		"name": "AW-P-EXEMPLO-1778",
		"description": "# 🚀 Get started here\n\nThis template guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests.\n\n## 🔖 **How to use this template**\n\n#### **Step 1: Send requests**\n\nRESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, and DELETE HTTP methods.\n\nThis collection contains each of these request types. Open each request and click \"Send\" to see what happens.\n\n#### **Step 2: View responses**\n\nObserve the response tab for status code (200 OK), response time, and size.\n\n#### **Step 3: Send new Body data**\n\nUpdate or add new data in \"Body\" in the POST request. Typically, Body data is also used in PUT request.\n\n```\n{\n    \"name\": \"Add your name in the body\"\n}\n\n```\n\n#### **Step 4: Update the variable**\n\nVariables enable you to store and reuse values in Postman. We have created a variable called `base_url` with the sample request [https://postman-api-learner.glitch.me](https://postman-api-learner.glitch.me). Replace it with your API endpoint to customize this collection.\n\n#### **Step 5: Add tests in the \"Tests\" tab**\n\nTests help you confirm that your API is working as expected. You can write test scripts in JavaScript and view the output in the \"Test Results\" tab.\n\n<img src=\"https://content.pstmn.io/b5f280a7-4b09-48ec-857f-0a7ed99d7ef8/U2NyZWVuc2hvdCAyMDIzLTAzLTI3IGF0IDkuNDcuMjggUE0ucG5n\">\n\n## 💪 Pro tips\n\n- Use folders to group related requests and organize the collection.\n- Add more scripts in \"Tests\" to verify if the API works as expected and execute flows.\n    \n\n## ℹ️ Resources\n\n[Building requests](https://learning.postman.com/docs/sending-requests/requests/)  \n[Authorizing requests](https://learning.postman.com/docs/sending-requests/authorization/)  \n[Using variables](https://learning.postman.com/docs/sending-requests/variables/)  \n[Managing environments](https://learning.postman.com/docs/sending-requests/managing-environments/)  \n[Writing scripts](https://learning.postman.com/docs/writing-scripts/intro-to-scripts/)",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
		"_exporter_id": "30298700"
	},
	"item": [
		{
			"name": "api/v1",
			"item": [
				{
					"name": "students/v1/",
					"item": [
						{
							"name": "GET: api/students",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Status code is 200\", function () {",
											"    pm.response.to.have.status(200);",
											"});"
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"method": "GET",
								"header": [],
								"url": {
									"raw": "{{base_url}}/api/students",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"students"
									]
								}
							},
							"response": []
						},
						{
							"name": "GET: api/students/:id",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Status code is 200\", function () {",
											"    pm.response.to.have.status(200);",
											"});"
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"method": "GET",
								"header": [],
								"url": {
									"raw": "{{base_url}}/api/students/1778",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"students",
										"1778"
									]
								},
								"description": "This is a GET request and it is used to \"get\" data from an endpoint. There is no request body for a GET request, but you can use query parameters to help specify the resource you want data on (e.g., in this request, we have `id=1`).\n\nA successful GET response will have a `200 OK` status, and should include some kind of response body - for example, HTML web content or JSON data."
							},
							"response": []
						},
						{
							"name": "POST: api/students/create",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful POST request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 201]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\n    \"number\": \"1778\",\n    \"name\": \"Marcelo Antunes Fernandes\",\n    \"city\": \"Braga\",\n    \"birthday\": \"17-09-1991\"\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/students/create",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"students",
										"create"
									]
								},
								"description": "This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.\n\nA successful POST request typically returns a `200 OK` or `201 Created` response code."
							},
							"response": []
						},
						{
							"name": "PUT: api/students/update",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful PUT request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 201, 204]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"method": "PUT",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\n    \"number\": \"1778\",\n    \"name\": \"Marcelo Filipe Antunes Fernandes\",\n    \"city\": \"Braga\",\n    \"birthday\": \"17-09-1991\"\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/students/update",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"students",
										"update"
									]
								},
								"description": "This is a PUT request and it is used to overwrite an existing piece of data. For instance, after you create an entity with a POST request, you may want to modify that later. You can do that using a PUT request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`).\n\nA successful PUT request typically returns a `200 OK`, `201 Created`, or `204 No Content` response code."
							},
							"response": []
						},
						{
							"name": "DELETE: api/students/delete",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful DELETE request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 202, 204]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"method": "DELETE",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/students/delete/1778",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"students",
										"delete",
										"1778"
									]
								},
								"description": "This is a DELETE request, and it is used to delete data that was previously created via a POST request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`).\n\nA successful DELETE request typically returns a `200 OK`, `202 Accepted`, or `204 No Content` response code."
							},
							"response": []
						}
					]
				}
			],
			"description": "Local Database"
		},
		{
			"name": "api/v2/",
			"item": [
				{
					"name": "students/v2",
					"item": [
						{
							"name": "GET: api/v2/students",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Status code is 200\", function () {",
											"    pm.response.to.have.status(200);",
											"});"
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"auth": {
									"type": "bearer",
									"bearer": [
										{
											"key": "token",
											"value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkMTNkMzMwLTkwMTktNGU0Yi04ZDIwLWFkOTk2NzcwMjIzMSIsIm5hbWUiOiJNYXJjZWxvIiwiaWF0IjoxNjk4NDEyMzQ3LCJleHAiOjE2OTkwMTcxNDd9.J-EKGn3x2QmbN7izBrMTQ8RcR4UCmE3HZy8e1r0Stao",
											"type": "string"
										}
									]
								},
								"method": "GET",
								"header": [],
								"url": {
									"raw": "{{base_url}}/api/v2/students",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"students"
									]
								}
							},
							"response": []
						},
						{
							"name": "GET: api/v2/students/:id",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Status code is 200\", function () {",
											"    pm.response.to.have.status(200);",
											"});"
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"auth": {
									"type": "bearer",
									"bearer": [
										{
											"key": "token",
											"value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkMTNkMzMwLTkwMTktNGU0Yi04ZDIwLWFkOTk2NzcwMjIzMSIsIm5hbWUiOiJNYXJjZWxvIiwiaWF0IjoxNjk4NDEyMzQ3LCJleHAiOjE2OTkwMTcxNDd9.J-EKGn3x2QmbN7izBrMTQ8RcR4UCmE3HZy8e1r0Stao",
											"type": "string"
										}
									]
								},
								"method": "GET",
								"header": [],
								"url": {
									"raw": "{{base_url}}/api/v2/students/1778",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"students",
										"1778"
									]
								},
								"description": "This is a GET request and it is used to \"get\" data from an endpoint. There is no request body for a GET request, but you can use query parameters to help specify the resource you want data on (e.g., in this request, we have `id=1`).\n\nA successful GET response will have a `200 OK` status, and should include some kind of response body - for example, HTML web content or JSON data."
							},
							"response": []
						},
						{
							"name": "POST: api/students/v2/create",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful POST request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 201]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"auth": {
									"type": "bearer",
									"bearer": [
										{
											"key": "token",
											"value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkMTNkMzMwLTkwMTktNGU0Yi04ZDIwLWFkOTk2NzcwMjIzMSIsIm5hbWUiOiJNYXJjZWxvIiwiaWF0IjoxNjk4NDEyMzQ3LCJleHAiOjE2OTkwMTcxNDd9.J-EKGn3x2QmbN7izBrMTQ8RcR4UCmE3HZy8e1r0Stao",
											"type": "string"
										}
									]
								},
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\n    \"number\": \"1778\",\n    \"name\": \"Marcelo Filipe Antunes Fernandes\",\n    \"city\": \"Braga\",\n    \"birthday\": \"17-09-1991\"\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/v2/students/create",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"students",
										"create"
									]
								},
								"description": "This is a POST request, submitting data to an API via the request body. This request submits JSON data, and the data is reflected in the response.\n\nA successful POST request typically returns a `200 OK` or `201 Created` response code."
							},
							"response": []
						},
						{
							"name": "PUT: api/students/v2/update",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful PUT request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 201, 204]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"auth": {
									"type": "bearer",
									"bearer": [
										{
											"key": "token",
											"value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkMTNkMzMwLTkwMTktNGU0Yi04ZDIwLWFkOTk2NzcwMjIzMSIsIm5hbWUiOiJNYXJjZWxvIiwiaWF0IjoxNjk4NDEyMzQ3LCJleHAiOjE2OTkwMTcxNDd9.J-EKGn3x2QmbN7izBrMTQ8RcR4UCmE3HZy8e1r0Stao",
											"type": "string"
										}
									]
								},
								"method": "PUT",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\n    \"number\": \"1778\",\n    \"name\": \"Marcelo Filipe\",\n    \"city\": \"Braga\",\n    \"birthday\": \"17-09-1991\"\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/v2/students/update",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"students",
										"update"
									]
								},
								"description": "This is a PUT request and it is used to overwrite an existing piece of data. For instance, after you create an entity with a POST request, you may want to modify that later. You can do that using a PUT request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`).\n\nA successful PUT request typically returns a `200 OK`, `201 Created`, or `204 No Content` response code."
							},
							"response": []
						},
						{
							"name": "DELETE: api/v2/students/delete",
							"event": [
								{
									"listen": "test",
									"script": {
										"exec": [
											"pm.test(\"Successful DELETE request\", function () {",
											"    pm.expect(pm.response.code).to.be.oneOf([200, 202, 204]);",
											"});",
											""
										],
										"type": "text/javascript"
									}
								}
							],
							"request": {
								"auth": {
									"type": "bearer",
									"bearer": [
										{
											"key": "token",
											"value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkMTNkMzMwLTkwMTktNGU0Yi04ZDIwLWFkOTk2NzcwMjIzMSIsIm5hbWUiOiJNYXJjZWxvIiwiaWF0IjoxNjk4NDEyMzQ3LCJleHAiOjE2OTkwMTcxNDd9.J-EKGn3x2QmbN7izBrMTQ8RcR4UCmE3HZy8e1r0Stao",
											"type": "string"
										}
									]
								},
								"method": "DELETE",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/v2/students/delete/1778",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"students",
										"delete",
										"1778"
									]
								},
								"description": "This is a DELETE request, and it is used to delete data that was previously created via a POST request. You typically identify the entity being updated by including an identifier in the URL (eg. `id=1`).\n\nA successful DELETE request typically returns a `200 OK`, `202 Accepted`, or `204 No Content` response code."
							},
							"response": []
						}
					]
				},
				{
					"name": "auth",
					"item": [
						{
							"name": "POST: api/v2/auth/signup",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"name\": \"Marcelo\",\r\n    \"email\": \"marcelo@ipvc.pt\",\r\n    \"password\": \"12345Qw!\",\r\n    \"isAdmin\": true\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/v2/auth/signup",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"auth",
										"signup"
									]
								}
							},
							"response": []
						},
						{
							"name": "POST: api/v2/auth/signin",
							"request": {
								"method": "POST",
								"header": [],
								"body": {
									"mode": "raw",
									"raw": "{\r\n    \"email\": \"marcelo@ipvc.pt\",\r\n    \"password\": \"12345Qw!\"\r\n}",
									"options": {
										"raw": {
											"language": "json"
										}
									}
								},
								"url": {
									"raw": "{{base_url}}/api/v2/auth/signin",
									"host": [
										"{{base_url}}"
									],
									"path": [
										"api",
										"v2",
										"auth",
										"signin"
									]
								}
							},
							"response": []
						}
					]
				}
			],
			"description": "Prisma ORM w/ PostgreSQL"
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "base_url",
			"value": "http://localhost:4242"
		}
	]
}