{"info":{"_postman_id":"54b20c17-fd0a-4c7c-b241-05394c1ea0eb","name":"Rock Paper Scissors API ","description":"# Welcome on Gosia´s first documentation for API.\n\n## Introduction:\nThis is Rock Paper Scissors - Game API for 2 players or for player vs computer.\n\n## Overview:\nI´m a java developer student, so this API isn´t perfekt yet, but works. :)\n\n## Authentication:\nYou have to use html-page made for API if you want to play the game. \n\n## Error Codes:\nIf you want to play PvP game when PvC game is taken or vice versa, you get the info that the game is taken by the other game variant and you must reset the game if you want to play. \n\n## Rate limit:\nThere is no limit to the number of requests an user can send (for today).\n\n## Collection for this API contains requests:\n* Get a value of all scores\n* Get a value of choice of Player 1\n* Get a value of choice of Player 2\n* Get a value of choice of Player 1 (human) and Player 2 (computer).\n* Post scores for Player 1\n* Post scores for Player 2\n* Post scores for ties\n* Post reset game \n* Put a value of all scores","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Get a value of all scores","id":"d024456e-3551-4171-9bf2-a68f4998eb8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores","protocol":"http","host":["localhost"],"port":"8080","path":["scores"],"query":[{"key":"scoresPlayer1","value":"","description":"returns a value of scores for Player 1","type":"text","disabled":true},{"key":"scoresPlayer2","value":"","description":"returns a value of scores for Player 2","disabled":true},{"key":"ties","value":"","description":"returns a value of scores for ties","type":"text","disabled":true}]},"description":"**API endpoint to get a value of all scores:**\n* scores for player 1: scoresPlayer1\n* scores for player 2: scoresPlayer2\n* scores for ties: ties \n\nReturns scores for Player 1, Player 2 and ties.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"8e2be6cb-8e3d-4fe0-a229-bd79e8bbd55b","name":"Get a value of all scores - example 1","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/","protocol":"http","host":["localhost"],"port":"8080","path":["scores",""],"query":[{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Date","value":"Wed, 19 Feb 2020 23:10:19 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n    \"scoresPlayer1\": \"3\",\n    \"scoresPlayer2\": \"2\",\n    \"ties\": \"2\"\n}"}],"_postman_id":"d024456e-3551-4171-9bf2-a68f4998eb8b"},{"name":"Get a value of choice of Player 1 (PvP)","id":"b77bf204-6758-43ef-9b22-8ff8487b139b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/player1","protocol":"http","host":["localhost"],"port":"8080","path":["scores","player1"],"query":[{"key":"getPlayer1Choice","value":"rock","description":"choose only one of values and send request","disabled":true},{"key":"getPlayer1Choice","value":"paper","description":"choose only one of values and send request","disabled":true},{"key":"getPlayer1Choice","value":"scissors","description":"choose only one of values and send request","disabled":true}]},"description":"**API endpoint to get a value of choice of Player 1 in PvP game:**\n\nParams to choose (choose only 1):\n* KEY: getPlayer1Choice, VALUE: rock\n* KEY: getPlayer1Choice, VALUE: paper\n* KEY: getPlayer1Choice, VALUE: scissors\n\nReturns information who winns, choises for Players, and scores for Player 1, Player 2 and ties.\n\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"763bd941-dac6-4876-bcc6-5e2bbf0a0317","name":"Get a value of choice of Player 1 (PvP) - example 1","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/player1?getPlayer1Choice=rock","protocol":"http","host":["localhost"],"port":"8080","path":["scores","player1"],"query":[{"key":"getPlayer1Choice","value":"rock"},{"key":"getPlayer1Choice","value":"paper","type":"text","disabled":true},{"key":"getPlayer1Choice","value":"scissors","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"123"},{"key":"Date","value":"Wed, 19 Feb 2020 22:50:15 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"It´s score draw.<br><br>Player 1: rock<br><br>Player 2: rock<br><br>{\"scoresPlayer1\":\"0\", \"scoresPlayer2\":\"0\", \"ties\":\"1\"}"}],"_postman_id":"b77bf204-6758-43ef-9b22-8ff8487b139b"},{"name":"Get a value of choice of Player 2 (PvP)","id":"ae6ca27b-8627-47c0-9f09-ca6dbdc3d7bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/player2","protocol":"http","host":["localhost"],"port":"8080","path":["scores","player2"],"query":[{"key":"getPlayer2Choice","value":"rock","description":"choose only one of values and send request","disabled":true},{"key":"getPlayer2Choice","value":"paper","description":"choose only one of values and send request","type":"text","disabled":true},{"key":"getPlayer2Choice","value":"scissors","description":"choose only one of values and send request","type":"text","disabled":true}]},"description":"**API endpoint to get a value of choice of Player 2 in PvP game:**\n\nParams to choose (choose only 1):\n* KEY: getPlayer2Choice, VALUE: rock\n* KEY: getPlayer2Choice, VALUE: paper\n* KEY: getPlayer2Choice, VALUE: scissors\n\nReturns information who winns, choises for Players, and scores for Player 1, Player 2 and ties.\n\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"6c8bac36-4e05-4d39-ae7f-e7e10481cecf","name":"Get a value of choice of Player 2 (PvP) - example 1","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/player2?getPlayer2Choice=scissors","protocol":"http","host":["localhost"],"port":"8080","path":["scores","player2"],"query":[{"key":"getPlayer2Choice","value":"rock","disabled":true},{"key":"getPlayer2Choice","value":"paper","type":"text","disabled":true},{"key":"getPlayer2Choice","value":"scissors"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"122"},{"key":"Date","value":"Wed, 19 Feb 2020 23:02:50 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Player 1 winns.<br><br>Player 1: paper<br><br>Player 2: rock<br><br>{\"scoresPlayer1\":\"2\", \"scoresPlayer2\":\"1\", \"ties\":\"1\"}"}],"_postman_id":"ae6ca27b-8627-47c0-9f09-ca6dbdc3d7bb"},{"name":"Get a value of choice of Player 1 and Player 2 (PvC)","id":"76a406bf-01e5-4830-a935-4ebcdc8bd7c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/playerVsComp","protocol":"http","host":["localhost"],"port":"8080","path":["scores","playerVsComp"],"query":[{"key":"getPlayer1Choice","value":"rock","type":"text","description":"choose only one of values and send request","disabled":true},{"key":"getPlayer1Choice","value":"paper","description":"choose only one of values and send request","disabled":true},{"key":"getPlayer1Choice","value":"scissors","description":"choose only one of values and send request","disabled":true}]},"description":"**API endpoint to get a value of choice of Player 1 in PvC game:**\n\nParams to choose (choose only 1):\n* KEY: getPlayer1Choice, VALUE: rock\n* KEY: getPlayer1Choice, VALUE: paper\n* KEY: getPlayer1Choice, VALUE: scissors\n\nParams for computer choose computer in random selection funktion.\n\nParams which computer choose for getPlayer2choice (only 1):\n* KEY: getPlayer2Choice, VALUE: rock\n* KEY: getPlayer2Choice, VALUE: paper\n* KEY: getPlayer2Choice, VALUE: scissors\n\nReturns information who winns, choises for Players, and scores for Player 1, Player 2 and ties.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"a351e8a2-1c4b-4030-9a84-c4f9ab6a48c6","name":"Get a value of choice of Player 1 and Player 2 (PvC) - example 2","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/playerVsComp?getPlayer1Choice=scissors","protocol":"http","host":["localhost"],"port":"8080","path":["scores","playerVsComp"],"query":[{"key":"getPlayer1Choice","value":"rock","type":"text","disabled":true},{"key":"getPlayer1Choice","value":"paper","disabled":true},{"key":"getPlayer1Choice","value":"scissors"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"33"},{"key":"Date","value":"Thu, 20 Feb 2020 11:59:36 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Game is taken by PVP. Reset game."},{"id":"fdc52663-375a-4ac0-8db1-1d0d05062ccf","name":"Get a value of choice of Player 1 and Player 2 (PvC) - example 1","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/playerVsComp?getPlayer1Choice=scissors","protocol":"http","host":["localhost"],"port":"8080","path":["scores","playerVsComp"],"query":[{"key":"getPlayer1Choice","value":"rock","disabled":true},{"key":"getPlayer1Choice","value":"paper","disabled":true},{"key":"getPlayer1Choice","value":"scissors"},{"key":"getPlayer2Choice","value":"rock","type":"text","disabled":true},{"key":"getPlayer2Choice","value":"paper","type":"text","disabled":true},{"key":"getPlayer2Choice","value":"scissors","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"120"},{"key":"Date","value":"Wed, 19 Feb 2020 23:26:27 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Computer winns.<br><br>You: scissors<br><br>Computer: rock<br><br>{\"scoresPlayer1\":\"0\", \"scoresPlayer2\":\"1\", \"ties\":\"2\"}"}],"_postman_id":"76a406bf-01e5-4830-a935-4ebcdc8bd7c4"},{"name":"Post scores for Player 1","id":"75953d73-0292-4a5e-9ab4-109d91c1d84e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/scoresPlayer1","protocol":"http","host":["localhost"],"port":"8080","path":["scores","scoresPlayer1"],"query":[{"key":"","value":"","type":"text","description":"posts and returns a number of scores of Player 1","disabled":true}]},"description":"**API endpoint to post scores for Player 1:**\n* scores for player 1: scoresPlayer1 \n\nPlayer 1 wins when chooses:\n* \"rock\" when Player 2 chooses \"scissors\"\n* \"paper\" when Player 2 chooses \"rock\"\n* \"scissors\" when Player 2 chooses \"paper\"\n\nReturns a number of scores for Player 1.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"3b0c80ab-58b0-480e-9171-40390a29db54","name":"Post scores for Player 1 - example 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/scoresPlayer1","protocol":"http","host":["localhost"],"port":"8080","path":["scores","scoresPlayer1"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 19 Feb 2020 23:06:24 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"3"}],"_postman_id":"75953d73-0292-4a5e-9ab4-109d91c1d84e"},{"name":"Post scores for Player 2","id":"c150bcb8-467a-4fa2-805b-f529cdfaec65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/scoresPlayer2","protocol":"http","host":["localhost"],"port":"8080","path":["scores","scoresPlayer2"],"query":[{"key":"","value":"","type":"text","description":"posts and returns a number of scores for Player 2","disabled":true}]},"description":"**API endpoint to post scores for Player 2:**\n* scores for player 2: scoresPlayer2\n\nPlayer 2 wins when chooses:\n* \"rock\" when Player 1 chooses \"paper\"\n* \"paper\" when Player 2 chooses \"scissors\"\n* \"scissors\" when Player 2 chooses \"rock\"\n\nReturns a number of scores for Player 2.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"f682be4b-117f-4719-bc31-5a0593f6a6f9","name":"Post scores for Player 2 - example 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/scoresPlayer2","protocol":"http","host":["localhost"],"port":"8080","path":["scores","scoresPlayer2"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 19 Feb 2020 23:07:42 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"2"}],"_postman_id":"c150bcb8-467a-4fa2-805b-f529cdfaec65"},{"name":"Post scores for ties","id":"727d3a2a-057c-427e-a6fa-8c17483995d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/ties","protocol":"http","host":["localhost"],"port":"8080","path":["scores","ties"],"query":[{"key":"","value":"","type":"text","description":"posts and returns a number of scores for ties","disabled":true}]},"description":"**API endpoint to post scores for ties:**\n* scores for ties: ties\n\nA tie is when both Players (1 and 2) have the same choice:\n* \"rock\" / \"rock\"\n* \"paper\" / \"paper\"\n* \"scissors\" / \"scissors\"\n\nReturns a number of scores for ties.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"dcc27557-0963-4d9f-a5a0-c6f72e084300","name":"Post scores for ties - example 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/scores/ties","protocol":"http","host":["localhost"],"port":"8080","path":["scores","ties"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 19 Feb 2020 23:08:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"2"}],"_postman_id":"727d3a2a-057c-427e-a6fa-8c17483995d9"},{"name":"Post reset game","id":"91716dd9-5907-418b-8d92-eb65a7a81a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/reset?resetValue=0","protocol":"http","host":["localhost"],"port":"8080","path":["reset"],"query":[{"key":"resetValue","value":"0","description":"posts and returns reset value = 0 for all scores"}]},"description":"**API endpoint to post reset game:**\n* scores for player 1: scoresPlayer1\n* scores for player 2: scoresPlayer2\n* scores for ties: ties \n\nParams:\n\nresetValue=0\n\nSets value 0 on each score-variable.\n\nReturns scores with value 0 for Player 1, Player 2 and ties.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"ba491e50-99f9-4854-ade3-fe127a255aed","name":"Post reset game - example 1","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:8080/reset?resetValue=0","protocol":"http","host":["localhost"],"port":"8080","path":["reset"],"query":[{"key":"resetValue","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"54"},{"key":"Date","value":"Wed, 19 Feb 2020 23:11:11 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\"scoresPlayer1\":\"0\", \"scoresPlayer2\":\"0\", \"ties\":\"0\"}"}],"_postman_id":"91716dd9-5907-418b-8d92-eb65a7a81a8e"},{"name":"Put a value of all scores","id":"55339ac3-9839-4df3-b903-cb9e21f7801e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":{"raw":"http://localhost:8080/scores?scoresPlayer1=2&scoresPlayer2=4&ties=6","protocol":"http","host":["localhost"],"port":"8080","path":["scores"],"query":[{"key":"scoresPlayer1","value":"2","description":"puts and returnes a value of scores for Player 1"},{"key":"scoresPlayer2","value":"4","description":"puts and returnes a value of scores for Player 2"},{"key":"ties","value":"6","description":"puts and returnes a value of scores for ties"}]},"description":"**API endpoint to put and update a value of all scores:**\n* scores for player 1: scoresPlayer1\n* scores for player 2: scoresPlayer2\n* scores for ties: ties \n\nReturns scores for Player 1, Player 2 and ties.\n\n>*A succesfull API request will return HTTP 200 status.*"},"response":[{"id":"48fd673f-0fb5-4129-acea-f249276a0ff8","name":"Put a value of all scores - example 1","originalRequest":{"method":"PUT","header":[],"url":{"raw":"http://localhost:8080/scores?scoresPlayer1=2&scoresPlayer2=4&ties=6","protocol":"http","host":["localhost"],"port":"8080","path":["scores"],"query":[{"key":"scoresPlayer1","value":"2"},{"key":"scoresPlayer2","value":"4"},{"key":"ties","value":"6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Date","value":"Wed, 19 Feb 2020 23:18:42 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n    \"scoresPlayer1\": \"2\",\n    \"scoresPlayer2\": \"4\",\n    \"ties\": \"6\"\n}"}],"_postman_id":"55339ac3-9839-4df3-b903-cb9e21f7801e"}]}