This template contains a boilerplate for documentation that you can quickly customize and reuse.
\ncodespan - feel free to read and remove them.Start with a brief overview of what your API offers.
The ((product name)) provides many API products, tools, and resources that enable you to ((add product value here)).
\nYou can also list the APIs you offer, link to the relevant pages, or do both in this section.
List the steps or points required to start using your APIs. Make sure to cover everything required to reach success with your API as quickly as possible.
To start using the ((add APIs here)), you need to -
\nThe points given below are from The Postman API's documentation. You can reference it to write your own getting started guide.
Add details on the authorization keys/tokens required, steps that cover how to get them, and the relevant error codes.
The ((product name)) API uses ((add your API's authorization type)) for authentication.
\nThe details given below are from the Postman API's documentation. You can reference it to write your own authentication section.
Postman uses API keys for authentication. You can generate a Postman API key in the API keys section of your Postman account settings.
\nYou must include an API key in each request to the Postman API with the X-Api-Key request header.
\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nUse this section to cover your APIs' terms of use. Include API limits, constraints, and relevant error codes, so consumers understand the permitted API usage and practices.
The example given below is from The Postman API's documentation. Use it as a reference to write your APIs' terms of use.
API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.
\nEach API response returns the following set of headers to help you identify your use status:
\nAn HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.
Add links that customers can refer to whenever they need help.
In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)).
\nOr you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.
\nYou can also document or add links to libraries, code examples, and other resources needed to make a request.
The user's username
\n","type":"text/plain"},"type":"any","value":"example","key":"username"}]}},"response":[{"id":"cbeaa435-8b36-492c-adba-7adb1e8d27e1","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"localhost:8080/users/{{ExistingUser}}","host":["localhost"],"port":"8080","path":["users","{{ExistingUser}}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 10:12:19 GMT"},{"key":"Server","value":"Apache/2.4.54 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.3"},{"key":"Content-Length","value":"209"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Example Name\",\n \"surname\": \"Example Surname\",\n \"username\": \"example\",\n \"bio\": \"This is a short Bio made for the @example user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n }\n]"},{"id":"d47abcc7-b25b-4e39-b51c-7e5f8f3d3f22","name":"404 NOT FOUND","originalRequest":{"method":"GET","header":[],"url":{"raw":"localhost:8080/users/{{NonExistingUser}}","host":["localhost"],"port":"8080","path":["users","{{NonExistingUser}}"],"query":[{"key":"","value":null,"disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 10:13:18 GMT"},{"key":"Server","value":"Apache/2.4.54 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.3"},{"key":"Content-Length","value":"2"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"496be5a9-0e9a-4df5-be1a-423c64628782"},{"name":"Get user's list with pagination","id":"7a6842f8-126d-446f-bf9c-62b4f42bab3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/users/page/:page/size/:size","urlObject":{"path":["users","page",":page","size",":size"],"host":["http://localhost:8080"],"query":[],"variable":[{"description":{"content":"The page number; it starts from 0
\n","type":"text/plain"},"type":"any","value":"0","key":"page"},{"type":"any","value":null,"key":"size"}]}},"response":[{"id":"4f6f4c0b-ca5c-46b8-bb47-b7f2e3076982","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/users/page/{{page}}/size/{{pageSize}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 10:24:36 GMT"},{"key":"Server","value":"Apache/2.4.54 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.3"},{"key":"Content-Length","value":"2171"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Example Name\",\n \"surname\": \"Example Surname\",\n \"username\": \"example\",\n \"bio\": \"This is a short Bio made for the @example user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Alexandr\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleAlexandr\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Andrea\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleAndrea\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Jessika\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleJessika\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name John\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleJohn\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Lukas\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleLukas\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Marcello\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleMarcello\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Martha\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleMartha\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Mary\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleMary\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n },\n {\n \"name\": \"Example Name Miriam\",\n \"surname\": \"Example Surname\",\n \"username\": \"exampleMiriam\",\n \"bio\": \"This is an example Bio for an example' user. \",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n }\n]"},{"id":"bf14e7cf-3a0c-4e84-9cdc-7cff04710fa3","name":"404 NOT FOUND","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/users/page/{{pageNotExisting}}/size/{{pageSize}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 10:25:55 GMT"},{"key":"Server","value":"Apache/2.4.54 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.3"},{"key":"Content-Length","value":"2"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"7a6842f8-126d-446f-bf9c-62b4f42bab3b"},{"name":"Search user with pagination","id":"4523e7a7-dbd1-48c9-b716-b0808467509b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/users/s/:query/page/:page/size/:size","urlObject":{"path":["users","s",":query","page",":page","size",":size"],"host":["http://localhost:8080"],"query":[],"variable":[{"description":{"content":"La stringa che deve essere contenuta negli username degli utenti
\n","type":"text/plain"},"type":"any","value":"ma","key":"query"},{"description":{"content":"Il numero della pagina; inizia da 0
\n","type":"text/plain"},"type":"any","value":"0","key":"page"},{"description":{"content":"La grandezza della pagina
\n","type":"text/plain"},"type":"any","value":"2","key":"size"}]}},"response":[{"id":"58fab6c7-4fe7-4eaa-a126-b1c212d1df37","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:8080/users/s/:query/page/:page/size/:size","host":["http://localhost:8080"],"path":["users","s",":query","page",":page","size",":size"],"variable":[{"key":"query","value":"ma","description":"La stringa che deve essere contenuta negli username degli utenti"},{"key":"page","value":"0","description":"Il numero della pagina; inizia da 0"},{"key":"size","value":"2","description":"La grandezza della pagina"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 04 Jun 2023 10:36:06 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"451"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"username\": \"exampleMarcello\",\n \"hash_password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\",\n \"nome\": \"Example Name Marcello\",\n \"cognome\": \"Example Surname\",\n \"bio\": \"This is an example Bio for an example' user. \"\n },\n {\n \"username\": \"exampleMartha\",\n \"hash_password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\",\n \"nome\": \"Example Name Martha\",\n \"cognome\": \"Example Surname\",\n \"bio\": \"This is an example Bio for an example' user. \"\n }\n]"}],"_postman_id":"4523e7a7-dbd1-48c9-b716-b0808467509b"}],"id":"346a9dca-88d1-4ee7-8725-c7a98cb706e0","description":"Questa cartella contiene le richieste che è possibile fare sulle entità logiche degli utenti.
\n","_postman_id":"346a9dca-88d1-4ee7-8725-c7a98cb706e0"},{"name":"Me","item":[{"name":"Register","id":"39deaacb-279f-4eea-9247-03708bf0ff72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n \"username\": \"newusername2\",\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/register","description":"Per registrarsi, l'utente deve fornire un body simile a quello mostrato di sotto. L'username non può contenere spazi, e può essere lungo massimo sedici caratteri.
\nLa password deve essere hashata dal client.
\n","urlObject":{"path":["register"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"a8ee6c65-b57f-4d0b-9f1d-e998dd90295a","name":"400 BAD REQUEST","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Your Name\",\n \"surname\": \"Your Surname\",\n \"username\": \"example\",\n \"bio\": \"This is my new Bio\",\n \"password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 11:31:01 GMT"},{"key":"Server","value":"Apache/2.4.54 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.3"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"User 'example' already exists. \"\n}"},{"id":"949dd821-2d35-41f2-b263-da287d2d80b4","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n \"username\": \"newusername\",\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 May 2023 15:10:01 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"2"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"d68ec344-a207-4fc6-8c8d-0a7d83c88b94","name":"400 BODY COULDNT BE VERIFIED","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 May 2023 15:16:20 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Body couldn't be verified\"\n}"},{"id":"6b65da9a-8591-4e73-938f-cd8584cf890d","name":"400 USERNAME LONGER THAN 16 CHARS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n \"username\": \"reallylongusername!\",\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 May 2023 15:16:58 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Username longer than sixteen characters\"\n}"},{"id":"6c914921-3965-4015-a7e3-41ef4c37c205","name":"400 USERNAME CONTAINS SPACES","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n \"username\": \"Incorrect Username\",\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 May 2023 15:17:34 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Username constains spaces\"\n}"},{"id":"f736ed72-147d-4395-abf4-46af9bffebcd","name":"500 DATABASE INTERNAL ERROR","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nome\": \"New Name\",\n \"cognome\": \"New Surname\",\n \"username\": \"newusername\",\n \"bio\": \"New Bio\",\n \"hash_password\": \"Hashed Password\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/register"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 May 2023 15:26:34 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Database internal error\"\n}"}],"_postman_id":"39deaacb-279f-4eea-9247-03708bf0ff72"},{"name":"Login","id":"f7dd8385-2a8c-429f-ac8c-815daa010548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"hash_password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/login","urlObject":{"path":["login"],"host":["http://localhost:8080"],"query":[],"variable":[]}},"response":[{"id":"8f3a4476-d9dd-4c1f-bef8-cbfde8040763","name":"404 USER CREDENTIALS NOT FOUND","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"NonExistingUser\",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/login"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 May 2023 15:14:36 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"User credentials not found\"\n}"},{"id":"cabf822a-66a5-446d-b856-2d2c103d0cb3","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"example\",\n \"password\": \"5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 May 2023 07:10:34 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"228"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bearer\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6ImV4YW1wbGUiLCJwYXNzd29yZCI6IjVFODg0ODk4REEyODA0NzE1MUQwRTU2RjhEQzYyOTI3NzM2MDNEMEQ2QUFCQkRENjJBMTFFRjcyMUQxNTQyRDgifQ.JTTtn2EM6X73Ao6SoPg8qUbd_xVNOkW7POLSwX_bUaA\"\n}"}],"_postman_id":"f7dd8385-2a8c-429f-ac8c-815daa010548"}],"id":"4f28c06a-7852-485f-a975-54bc70926ab0","description":"Questa cartella contiene i metodi e gli endpoints con i quali è possibile gestire le informazioni del proprio utente.
\n","_postman_id":"4f28c06a-7852-485f-a975-54bc70926ab0"},{"name":"Me (authorization required)","item":[{"name":"Get user's information","id":"180a81b4-99ca-41eb-b112-6acaeaf94b71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/me","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"La pagina; inizia da 0
\n","type":"text/plain"},"type":"any","value":"0","key":"page"},{"description":{"content":"La grandezza della pagina
\n","type":"text/plain"},"type":"any","value":"10","key":"size"}]}},"response":[],"_postman_id":"05d4fc14-6052-4081-a297-1e449f6d64e7"}],"id":"06f8e66c-7738-4557-89c9-19ca56a36766","description":"Questa cartella raccoglie tutti i metodi Me che richiedono l'autenticazione Bearer.
Gli errori legati all'autenticazione includono, ma non sono ristretti ai seguenti: LoginCredentialsNotFound, nel caso in cui le credenziali non siano valide per l'accesso; FailedToGetAuthField nel caso in cui il campo Authentication sia mancante.
Alcuni di questi casi non sono contemplati nelle chiamate di seguito.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The post's ID
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"a9d8828a-6db0-490f-8e0d-5890b9b23201","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/post/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Jun 2023 15:10:12 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"129"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"content\": \"Ciao\",\n \"post_commentato\": null,\n \"autore\": \"example\",\n \"data_creazione\": \"2023-06-01 15:00:07\",\n \"count(`like`.id)\": 0\n }\n]"},{"id":"667e4fc2-b69b-4d05-b373-f2011dcaf6d8","name":"404 NOT FOUND","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/post/3498"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Jun 2023 15:13:09 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.5"},{"key":"Content-Length","value":"39"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Item does not exist\"\n}"}],"_postman_id":"c4026a4b-d77f-47f3-8041-90c21a34481c"},{"name":"Get post by user with pagination","id":"49a62f0b-720e-459c-a843-4fb66bf279b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/user/:username/posts/page/:page/size/:size","urlObject":{"path":["user",":username","posts","page",":page","size",":size"],"host":["http://localhost:8080"],"query":[],"variable":[{"description":{"content":"The username of the user the posts are needed
\n","type":"text/plain"},"type":"any","value":"example","key":"username"},{"description":{"content":"The page number; it starts from 0
\n","type":"text/plain"},"type":"any","value":"0","key":"page"},{"type":"any","value":"10","key":"size"}]}},"response":[],"_postman_id":"49a62f0b-720e-459c-a843-4fb66bf279b7"}],"id":"bfdbc014-4186-47a5-bc50-778aecc83466","_postman_id":"bfdbc014-4186-47a5-bc50-778aecc83466","description":""},{"name":"Post (authorization required)","item":[{"name":"Update post's content","id":"d140f6c8-17fa-4a7c-9b02-73cc669b6000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"new_content\": \"Ciao a tutti\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/post/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Il campo post_commentato, se nullo, deve essere indicato come \"null\", e non come null, senza virgolette.
Nell'esempio di seguito, si nota come il server PHP non sia in grado di riconoscere un campo settato a null da un campo non settato.
Questa cartella raccoglie tutti i metodi Post che richiedono l'autenticazione Bearer.
Gli errori legati all'autenticazione includono, ma non sono ristretti ai seguenti: LoginCredentialsNotFound, nel caso in cui le credenziali non siano valide per l'accesso; FailedToGetAuthField nel caso in cui il campo Authentication sia mancante.
Alcuni di questi casi non sono contemplati nelle chiamate di seguito.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The post's ID the like number is needed
\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[{"id":"c1cda76d-f70e-4baa-bd28-7df32c0762e8","name":"404 NOT FOUND","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/post/5/likes"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Jun 2023 17:19:03 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.6"},{"key":"Content-Length","value":"39"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_message\": \"Item does not exist\"\n}"},{"id":"f0584604-1263-4fcd-9f01-aa7edee6abd8","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"localhost:8080/post/4/likes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Jun 2023 17:20:10 GMT"},{"key":"Server","value":"Apache/2.4.56 (Debian)"},{"key":"X-Powered-By","value":"PHP/8.2.6"},{"key":"Content-Length","value":"13"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"likes\": 1\n }\n]"}],"_postman_id":"62cf8dbc-d4f6-4c19-9dd8-5cfcf3d66b27"}],"id":"b02d0388-8cc5-456a-a78f-8c79d583dc02","_postman_id":"b02d0388-8cc5-456a-a78f-8c79d583dc02","description":""},{"name":"Likes (authorization required)","item":[{"name":"Insert like to post","id":"997680ca-cbb4-4afe-8f9a-f29cb5680988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:8080/post/:id/likes","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The ID of the post to like
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"997680ca-cbb4-4afe-8f9a-f29cb5680988"},{"name":"Remove like from post","id":"eea80c46-1798-495b-a406-c85bb4323c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/post/:id/likes","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The post's ID
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"eea80c46-1798-495b-a406-c85bb4323c2c"}],"id":"03b82b89-666c-444c-a317-2b4e1510f2fd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"L'username dell'utente
\n","type":"text/plain"},"type":"any","value":"example","key":"username"},{"description":{"content":"La pagina; inizia da 0
\n","type":"text/plain"},"type":"any","value":"0","key":"page"},{"description":{"content":"La grandezza della pagina
\n","type":"text/plain"},"type":"any","value":"10","key":"size"}]}},"response":[],"_postman_id":"22773023-9712-43e4-a209-4318558a4dc5"},{"name":"Is a follower of user","id":"f46505f6-3ed3-47aa-bb63-2cef3977c5a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/user/:username/followers/is/:follower","urlObject":{"path":["user",":username","followers","is",":follower"],"host":["http://localhost:8080"],"query":[],"variable":[{"description":{"content":"L'utente del quale si vuole sapere il follower
\n","type":"text/plain"},"type":"any","value":"example","key":"username"},{"description":{"content":"Il follower
\n","type":"text/plain"},"type":"any","value":"example","key":"follower"}]}},"response":[],"_postman_id":"f46505f6-3ed3-47aa-bb63-2cef3977c5a2"},{"name":"New Request","id":"e5a1c5d2-a601-4862-8df1-af1d0dfe8f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e5a1c5d2-a601-4862-8df1-af1d0dfe8f36"}],"id":"7e4587c8-9e0b-47a0-9c64-1f5c8c3dcd87","_postman_id":"7e4587c8-9e0b-47a0-9c64-1f5c8c3dcd87","description":""},{"name":"Followers (authorization required)","item":[{"name":"Follow a new user","id":"cffaefe2-57c7-4c83-b75d-dc3915d8b4f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:8080/users/:username/followers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"L'utente da seguire
\n","type":"text/plain"},"type":"any","value":"example","key":"username"}]}},"response":[],"_postman_id":"cffaefe2-57c7-4c83-b75d-dc3915d8b4f1"},{"name":"Unfollow a user","id":"5acdd0ef-e939-4c9d-9b91-70b056a1ebbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/users/:username/followers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"