<!DOCTYPE html><html><head><metacharset="utf-8"><title>Go Game</title><linkrel="stylesheet"href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@importurl('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby.hljs-constant,.xml.hljs-tag.hljs-title,.xml.hljs-pi,.xml.hljs-doctype,.html.hljs-doctype,.css.hljs-id,.css.hljs-class,.css.hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby.hljs-class.hljs-title,.css.hljs-rules.hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby.hljs-symbol,.xml.hljs-cdata{color:#718c00}.css.hljs-hexcolor{color:#3e999f}.hljs-function,.python.hljs-decorator,.python.hljs-title,.ruby.hljs-function.hljs-title,.ruby.hljs-title.hljs-keyword,.perl.hljs-sub,.javascript.hljs-title,.coffeescript.hljs-title{color:#4271ae}.hljs-keyword,.javascript.hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript.javascript,.javascript.xml,.tex.hljs-formula,.xml.javascript,.xml.vbscript,.xml.css,.xml.hljs-cdata{opacity:.5}.right.hljs-comment{color:#969896}.right.css.hljs-class,.right.css.hljs-id,.right.css.hljs-pseudo,.right.hljs-attribute,.right.hljs-regexp,.right.hljs-tag,.right.hljs-variable,.right.html.hljs-doctype,.right.ruby.hljs-constant,.right.xml.hljs-doctype,.right.xml.hljs-pi,.right.xml.hljs-tag.hljs-title{color:#c66}.right.hljs-built_in,.right.hljs-constant,.right.hljs-literal,.right.hljs-number,.right.hljs-params,.right.hljs-pragma,.right.hljs-preprocessor{color:#de935f}.right.css.hljs-rule.hljs-attribute,.right.ruby.hljs-class.hljs-title{color:#f0c674}.right.hljs-header,.right.hljs-inheritance,.right.hljs-name,.right.hljs-string,.right.hljs-value,.right.ruby.hljs-symbol,.right.xml.hljs-cdata{color:#b5bd68}.right.css.hljs-hexcolor,.right.hljs-title{color:#8abeb7}.right.coffeescript.hljs-title,.right.hljs-function,.right.javascript.hljs-title,.right.perl.hljs-sub,.right.python.hljs-decorator,.right.python.hljs-title,.right.ruby.hljs-function.hljs-title,.right.ruby.hljs-title.hljs-keyword{color:#81a2be}.right.hljs-keyword,.right.javascript.hljs-function{color:#b294bb}.right.hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right.coffeescript.javascript,.right.javascript.xml,.right.tex.hljs-formula,.right.xml.css,.right.xml.hljs-cdata,.right.xml.javascript,.right.xml.vbscript{opacity:.5}body{color:black;background:white;font:40014px/1.42'Roboto',Helvetica,sans-serif}header{border-bottom:1pxsolid#f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px0}h1.permalink,h2.permalink,h3.permalink,h4.permalink,h5.permalink{margin-left:0;opacity:0;transition:opacity.25sease}h1:hover.permalink,h2:hover.permalink,h3:hover.permalink,h4:hover.permalink,h5:hover.permalink{opacity:1}.tripleh1.permalink,.tripleh2.permalink,.tripleh3.permalink,.tripleh4.permalink,.tripleh5.permalink{opacity:.15}.tripleh1:hover.permalink,.tripleh2:hover.permalink,.tripleh3:hover.permalink,.tripleh4:hover.permalink,.tripleh5:hover.permalink{opacity:.15}h1{font:20036px'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:20036px'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0010px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}lip{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12pxauto;background-image:linear-gradient(toright,rgba(0,0,0,0)20%,rgba(0,0,0,0.2)51.4%,rgba(255,255,255,0.2)51.4%,rgba(255,255,255,0)80%)}dldt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dldd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px20px;margin:12px0;border-left:5pxsolid#e8e8e8}blockquotep:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1pxsolid#cfcfcf;border-radius:6px;overflow:auto}precode{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px4px;border:1pxsolid#cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}tabletr:nth-child(2n){background-color:#fafafa}tableth,tabletd{padding:6px12px;border:1pxsolid#e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em1em;margin:1em0;border-radius:2px;font-size:90%}.noteh1,.warningh1,.noteh2,.warningh2,.noteh3,.warningh3,.noteh4,.warningh4,.noteh5,.warningh5,.noteh6,.warningh6{font-family:20036px'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.notep,.warningp{margin:.5em0}.note{color:black;background-color:#f0f6fb;border-left:4pxsolid#428bca}.noteh1,.noteh2,.noteh3,.noteh4,.noteh5,.noteh6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4pxsolid#c9302c}.warningh1,.warningh2,.warningh3,.warningh4,.warningh5,.warningh6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav.resource-group{padding:0}nav.resource-group.heading{position:relative}nav.resource-group.heading.chevron{position:absolute;top:12px;right:12px;opacity:.5}nav.resource-group.headinga{display:block;color:black;opacity:.7;border-left:2pxsolidtransparent;margin:0}nav.resource-group.headinga:hover{text-decoration:none;background-color:bad-color;border-left:2pxsolidblack}navul{list-style-type:none;padding-left:0}navula{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px12px;border-top:1pxsolid#d9d9d9;border-left:2pxsolidtransparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}navula:hover{text-decoration:none;background-color:bad-color;border-left:2pxsolidblack}navul>li{margin:0}navul>li:first-child{margin-top:-12px}navul>li:last-child{margin-bottom:-12px}navulula{padding-left:24px}navululli{margin:0}navululli:first-child{margin-top:0}navululli:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload*{transition:none!important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button.close{display:none;color:#428bca;cursor:pointer}.collapse-button.open{color:#428bca;cursor:pointer}.collapse-button.show.close{display:inline}.collapse-button.show.open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height.3sease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container.row.content{margin-left:244px;width:696px}.container.row:after{content:'';display:block;clear:both}.container-fluidnav{width:22%}.container-fluid.row.content{margin-left:24%}.container-fluid.triplenav{width:16.5%;padding-right:1px}.container-fluid.triple.row.content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.righta{color:#428bca}.righth1,.righth2,.righth3,.righth4,.righth5,.rightp,.rightdiv{color:white}.rightpre{background-color:#1d1f21;border:1pxsolid#1d1f21}.rightprecode{color:#c5c8c6}.right.description{margin-top:12px}.triple.resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition.method{font-weight:bold}.definition.method.get{color:#2e8ab8}.definition.method.head{color:#2e8ab8}.definition.method.options{color:#2e8ab8}.definition.method.post{color:#56b82e}.definition.method.put{color:#b8a22e}.definition.method.patch{color:#b8a22e}.definition.method.delete{color:#b82e2e}.definition.uri{word-break:break-all;word-wrap:break-word}.definition.hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names.tab-button{cursor:pointer;color:black;border:1pxsolid#ddd;padding:6px;margin-left:12px}.example-names.tab-button.active{background-color:#d5d5d5}.right.example-names{background-color:#444}.right.example-names.tab-button{color:white;border:1pxsolid#666;border-radius:6px}.right.example-names.tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1pxsolid#f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media(max-width:1200px){nav{width:198px}.container{max-width:840px}.container.row.content{margin-left:224px;width:606px}}@media(max-width:992px){nav{width:169.4px}.container{max-width:720px}.container.row.content{margin-left:194px;width:526px}}@media(max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container.row.content,.container-fluid.row.content,.container-fluid.triple.row.content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none!important;border-top:1pxsolid#d9d9d9;border-left:1pxsolid#d9d9d9;border-right:1pxsolid#d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1pxsolid#d9d9d9;border-radius:6px}.resource-grouph2.group-heading,.resource-group.headinga{padding:12px;margin:-12px-12px12px-12px;background-color:#f2f2f2;border-bottom:1pxsolid#d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple.content.resource-group{padding:0;border:none}.triple.content.resource-grouph2.group-heading,.triple.content.resource-group.headinga{margin:0012px0;border:1pxsolid#d9d9d9}nav.resource-group.headinga{padding:12px;margin-bottom:0}nav.resource-group.collapse-content{padding:0}.action{margin-bottom:12px;padding:12px12px012px;overflow:hidden;border:1pxsolidtransparent;border-radius:6px}.actionh4.action-heading{padding:6px12px;margin:-12px-12px12px-12px;border-bottom:1pxsolidtransparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.actionh4.action-heading.name{float:right;font-weight:normal;padding:6px0}.actionh4.action-heading.method{padding:6px12px;margin-right:12px;border-radius:3px;display:inline-block}.actionh4.action-heading.method.get{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.head{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.options{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.put{color:#fff;background-color:#ed9c28}.actionh4.action-heading.method.patch{color:#fff;background-color:#ed9c28}.actionh4.action-heading.method.post{color:#fff;background-color:#5cb85c}.actionh4.action-heading.method.delete{color:#fff;background-color:#d9534f}.actionh4.action-headingcode{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.actiondl.inner{padding-bottom:2px}.action.title{border-bottom:1pxsolidwhite;margin:0-12px-1px-12px;padding:12px}.action.get{border-color:#bce8f1}.action.geth4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.headh4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.optionsh4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.posth4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.puth4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patchh4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.deleteh4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><bodyclass="preload"><ahref="#top"class="text-muted back-to-top"><iclass="fa fa-toggle-up"></i> Back to top</a><divclass="container"><divclass="row"><nav><divclass="resource-group"><divclass="heading"><divclass="chevron"><iclass="open fa fa-angle-down"></i></div><ahref="#matches">Matches</a></div><divclass="collapse-content"><ul><li><ahref="#matches-matches-collection">Matches Collection</a><ul><li><ahref="#matches-matches-collection-get"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>List All Matches</a></li><li><ahref="#matches-matches-collection-post"><spanclass="badge post"><iclass="fa fa-plus"></i></span>Start a New Match</a></li></ul></li><li><ahref="#matches-match-status">Match Status</a><ul><li><ahref="#matches-match-status-get"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>Get Match Details</a></li><li><ahref="#matches-match-status-get-1"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>Get Current Liberties for Match</a></li><li><ahref="#matches-match-status-get-2"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>Get Current Chains for Match</a></li></ul></li></ul></div></div><divclass="resource-group"><divclass="heading"><divclass="chevron"><iclass="open fa fa-angle-down"></i></div><ahref="#moves">Moves</a></div><divclass="collapse-content"><ul><li><ahref="#moves-moves-collection">Moves Collection</a><ul><li><ahref="#moves-moves-collection-get"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>Get a Sequential List of All Moves Performed in a Match</a></li><li><ahref="#moves-moves-collection-post"><spanclass="badge post"><iclass="fa fa-plus"></i></span>Make a Move</a></li></ul></li></ul></div></div><pstyle="text-align: center; word-wrap: break-word;"><ahref="http://localhost:3000">http://localhost:3000</a></p></nav><divclass="content"><header><h1id="top">Go Game</h1></header><p>This is a simple API for a small game server handling the game of Go. For the rules used as a reference when building this application,
see <ahref="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p>
<sectionid="matches"class="resource-group"><h2class="group-heading">Matches <ahref="#matches"class="permalink">¶</a></h2><p>A match is the unit of active gameplay within Go. Each match is assigned a unique GUID upon creation, and all references to the match
via this API are thereafter keyed by the match ID.</p>
<divid="matches-matches-collection"class="resource"><h3class="resource-heading">Matches Collection <ahref="#matches-matches-collection"class="permalink"> ¶</a></h3><p>The matches collection represents the matches currently ongoing being handled by the server at the time. It does not cover historical access to old game records.</p>
<divid="matches-matches-collection-get"class="action get"><h4class="action-heading"><divclass="name">List All Matches</div><ahref="#matches-matches-collection-get"class="method get">GET</a><codeclass="uri">/matches</code></h4><p>Lists all currently active matches on the server.</p>
]</code></pre><divstyle="height: 1px;"></div></div></div></div><divid="matches-matches-collection-post"class="action post"><h4class="action-heading"><divclass="name">Start a New Match</div><ahref="#matches-matches-collection-post"class="method post">POST</a><codeclass="uri">/matches</code></h4><p>You can create a new match with this action. It takes information about the players and will set up a new game. The game will start at round 1, and it will be <strong>black</strong>'s turn to
play. Per standard Go rules, <strong>black</strong> plays first.</p>
</span>}</code></pre><divstyle="height: 1px;"></div></div></div></div></div><divid="matches-match-status"class="resource"><h3class="resource-heading">Match Status <ahref="#matches-match-status"class="permalink"> ¶</a></h3><p>Use the match status resource to interrogate various aspects of an individual running match.</p>
<divid="matches-match-status-get"class="action get"><h4class="action-heading"><divclass="name">Get Match Details</div><ahref="#matches-match-status-get"class="method get">GET</a><codeclass="uri">/matches/{match_id}</code></h4><p>Query the details of an ongoing match.</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method get">GET</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/matches/<spanclass="hljs-attribute"title="match_id">5a003b78-409e-4452-b456-a6f0dcee05bd</span></span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>match_id</dt><dd><code>string</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>5a003b78-409e-4452-b456-a6f0dcee05bd</span></span><p>The id of the running match.</p>
</span>}</code></pre><divstyle="height: 1px;"></div></div></div></div><divid="matches-match-status-get-1"class="action get"><h4class="action-heading"><divclass="name">Get Current Liberties for Match</div><ahref="#matches-match-status-get-1"class="method get">GET</a><codeclass="uri">/matches/{match_id}/liberties</code></h4><p>Liberties are positions adjacent to a player chain. You might use this resource if your game client implements a hint or cheat functionality that highlights potential positions onto which a player can place a stone.</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method get">GET</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/matches/<spanclass="hljs-attribute"title="match_id">5a003b78-409e-4452-b456-a6f0dcee05bd</span>/liberties</span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>match_id</dt><dd><code>string</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>5a003b78-409e-4452-b456-a6f0dcee05bd</span></span><p>The id of the running match.</p>
]</code></pre><divstyle="height: 1px;"></div></div></div></div><divid="matches-match-status-get-2"class="action get"><h4class="action-heading"><divclass="name">Get Current Chains for Match</div><ahref="#matches-match-status-get-2"class="method get">GET</a><codeclass="uri">/matches/{match_id}/chains</code></h4><p>A chain is a list of adjacent stones. See Go rules for a definition of adjacent. Note that a single stone can be considered a chain.
You might want to use this resource if your game client implements handy functionality that might highlight any
given player’s chains to aid them in strategy.</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method get">GET</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/matches/<spanclass="hljs-attribute"title="match_id">5a003b78-409e-4452-b456-a6f0dcee05bd</span>/chains</span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>match_id</dt><dd><code>string</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>5a003b78-409e-4452-b456-a6f0dcee05bd</span></span><p>The id of the running match.</p>
]</code></pre><divstyle="height: 1px;"></div></div></div></div></div></section><sectionid="moves"class="resource-group"><h2class="group-heading">Moves <ahref="#moves"class="permalink">¶</a></h2><p>A move consists of a single player placing a stone on the board. Players have the option of <strong>passing</strong> on a given turn, in which case the position field may
be missing or empty, indicating a pass. A turn consists of both players having performed a <strong>move</strong>.</p>
<divid="moves-moves-collection"class="resource"><h3class="resource-heading">Moves Collection <ahref="#moves-moves-collection"class="permalink"> ¶</a></h3><p>This resource is available for interrogating moves within a match, or for players to perform a move.</p>
<divid="moves-moves-collection-get"class="action get"><h4class="action-heading"><divclass="name">Get a Sequential List of All Moves Performed in a Match</div><ahref="#moves-moves-collection-get"class="method get">GET</a><codeclass="uri">/matches/{match_id}/moves</code></h4><p>If you need to get a time-ordered list of every position claimed by players in a match, you can use this resource. This might
be helpful if your game client needs to maintain a UI element that displays the list of moves taken thus far. This only
works for active matches, and is not intended for historical queries.</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method get">GET</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/matches/<spanclass="hljs-attribute"title="match_id">5a003b78-409e-4452-b456-a6f0dcee05bd</span>/moves</span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>match_id</dt><dd><code>string</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>5a003b78-409e-4452-b456-a6f0dcee05bd</span></span><p>The id of the running match.</p>
]</code></pre><divstyle="height: 1px;"></div></div></div></div><divid="moves-moves-collection-post"class="action post"><h4class="action-heading"><divclass="name">Make a Move</div><ahref="#moves-moves-collection-post"class="method post">POST</a><codeclass="uri">/matches/{match_id}/moves</code></h4><p>Use this resource to submit a move to the game server. If the move is an illegal move, then the server will reply with a <strong>400</strong> status code, indicating
a bad request. The reply will contain a message describing the reason for the failed attempt to move.
Reasons for receiving messages about an illegal move:</p>
<ul>
<li>
<p>Position is already occupied</p>
</li>
<li>
<p>Position is not one of the player’s current liberties</p>
</li>
<li>
<p>After the move would be evaluated and captures evaluated, the move would result in self-capture (suicide)</p>
</li>
<li>
<p>The move would result in a violation of the <strong>superko</strong> rule, which prevents the game board from being put in a state in which it has previously been within this match.</p>
</li>
</ul>
<p>A move containing a position is considered a <strong>play</strong> while a move without a position is considered a <strong>pass</strong>.</p>
<p>Leaving the <strong>position</strong> field empty indicates a pass.</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method post">POST</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/matches/<spanclass="hljs-attribute"title="match_id">5a003b78-409e-4452-b456-a6f0dcee05bd</span>/moves</span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>match_id</dt><dd><code>string</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>5a003b78-409e-4452-b456-a6f0dcee05bd</span></span><p>The id of the running match.</p>
This is a simple API for a small game server handling the game of Go. For the rules used as a reference when building this application,
方便设计API的文档规范. For the rules used as a reference when building this application,
see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
# Group upms
# Group upms
A match is the unit of active gameplay within Go. Each match is assigned a unique GUID upon creation, and all references to the match
这是个例子用UMPS用户模块来说明通用接口规范如何定义
via this API are thereafter keyed by the match ID.
## upms user
## upms user
The matches collection represents the matches currently ongoing being handled by the server at the time. It does not cover historical access to old game records.
用户模块
### user page [GET /admin/user/page]
### user page [GET /admin/user/page{?current,size,other}]
用户分页.
用户分页
+ Parameters
+ current (number, optional) - 当前页
+ Default: `1`
+ size (number, optional) - 每页几条
+ Default: `20`
+ other (number, optional) - 这里是搜索参数, 如 `username` 用户名搜索.
+ Default: `张超`
+ Response 200 (application/json)
+ Response 200 (application/json)
...
@@ -27,13 +35,22 @@ The matches collection represents the matches currently ongoing being handled by
...
@@ -27,13 +35,22 @@ The matches collection represents the matches currently ongoing being handled by
用户新增.
用户新增.
+ Request (application/json)
{
"username" : "zhangchao",
"playerWhite" : "bob",
"playerBlack" : "alfred"
}
+ Response 200 (application/json)
+ Response 200 (application/json)
{"code":0,"msg":"success","data":true}
{"code":0,"msg":"success","data":true}
### delete user [POST /admin/user/delete/{id}]
### delete user [POST /admin/user/delete/{id}]
Liberties are positions adjacent to a player chain. You might use this resource if your game client implements a hint or cheat functionality that highlights potential positions onto which a player can place a stone.
用户删除
+ Parameters
+ Parameters
...
@@ -44,15 +61,19 @@ Liberties are positions adjacent to a player chain. You might use this resource
...
@@ -44,15 +61,19 @@ Liberties are positions adjacent to a player chain. You might use this resource
{"code":0,"msg":"success","data":true}
{"code":0,"msg":"success","data":true}
### update user [POST /admin/user/update/{id}]
### update user [POST /admin/user/update]
A chain is a list of adjacent stones. See Go rules for a definition of adjacent. Note that a single stone can be considered a chain.
用户更新
You might want to use this resource if your game client implements handy functionality that might highlight any
<!DOCTYPE html><html><head><metacharset="utf-8"><title>接口规范</title><linkrel="stylesheet"href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@importurl('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby.hljs-constant,.xml.hljs-tag.hljs-title,.xml.hljs-pi,.xml.hljs-doctype,.html.hljs-doctype,.css.hljs-id,.css.hljs-class,.css.hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby.hljs-class.hljs-title,.css.hljs-rules.hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby.hljs-symbol,.xml.hljs-cdata{color:#718c00}.css.hljs-hexcolor{color:#3e999f}.hljs-function,.python.hljs-decorator,.python.hljs-title,.ruby.hljs-function.hljs-title,.ruby.hljs-title.hljs-keyword,.perl.hljs-sub,.javascript.hljs-title,.coffeescript.hljs-title{color:#4271ae}.hljs-keyword,.javascript.hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript.javascript,.javascript.xml,.tex.hljs-formula,.xml.javascript,.xml.vbscript,.xml.css,.xml.hljs-cdata{opacity:.5}.right.hljs-comment{color:#969896}.right.css.hljs-class,.right.css.hljs-id,.right.css.hljs-pseudo,.right.hljs-attribute,.right.hljs-regexp,.right.hljs-tag,.right.hljs-variable,.right.html.hljs-doctype,.right.ruby.hljs-constant,.right.xml.hljs-doctype,.right.xml.hljs-pi,.right.xml.hljs-tag.hljs-title{color:#c66}.right.hljs-built_in,.right.hljs-constant,.right.hljs-literal,.right.hljs-number,.right.hljs-params,.right.hljs-pragma,.right.hljs-preprocessor{color:#de935f}.right.css.hljs-rule.hljs-attribute,.right.ruby.hljs-class.hljs-title{color:#f0c674}.right.hljs-header,.right.hljs-inheritance,.right.hljs-name,.right.hljs-string,.right.hljs-value,.right.ruby.hljs-symbol,.right.xml.hljs-cdata{color:#b5bd68}.right.css.hljs-hexcolor,.right.hljs-title{color:#8abeb7}.right.coffeescript.hljs-title,.right.hljs-function,.right.javascript.hljs-title,.right.perl.hljs-sub,.right.python.hljs-decorator,.right.python.hljs-title,.right.ruby.hljs-function.hljs-title,.right.ruby.hljs-title.hljs-keyword{color:#81a2be}.right.hljs-keyword,.right.javascript.hljs-function{color:#b294bb}.right.hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right.coffeescript.javascript,.right.javascript.xml,.right.tex.hljs-formula,.right.xml.css,.right.xml.hljs-cdata,.right.xml.javascript,.right.xml.vbscript{opacity:.5}body{color:black;background:white;font:40014px/1.42'Roboto',Helvetica,sans-serif}header{border-bottom:1pxsolid#f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px0}h1.permalink,h2.permalink,h3.permalink,h4.permalink,h5.permalink{margin-left:0;opacity:0;transition:opacity.25sease}h1:hover.permalink,h2:hover.permalink,h3:hover.permalink,h4:hover.permalink,h5:hover.permalink{opacity:1}.tripleh1.permalink,.tripleh2.permalink,.tripleh3.permalink,.tripleh4.permalink,.tripleh5.permalink{opacity:.15}.tripleh1:hover.permalink,.tripleh2:hover.permalink,.tripleh3:hover.permalink,.tripleh4:hover.permalink,.tripleh5:hover.permalink{opacity:.15}h1{font:20036px'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:20036px'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0010px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}lip{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12pxauto;background-image:linear-gradient(toright,rgba(0,0,0,0)20%,rgba(0,0,0,0.2)51.4%,rgba(255,255,255,0.2)51.4%,rgba(255,255,255,0)80%)}dldt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dldd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px20px;margin:12px0;border-left:5pxsolid#e8e8e8}blockquotep:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1pxsolid#cfcfcf;border-radius:6px;overflow:auto}precode{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px4px;border:1pxsolid#cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}tabletr:nth-child(2n){background-color:#fafafa}tableth,tabletd{padding:6px12px;border:1pxsolid#e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em1em;margin:1em0;border-radius:2px;font-size:90%}.noteh1,.warningh1,.noteh2,.warningh2,.noteh3,.warningh3,.noteh4,.warningh4,.noteh5,.warningh5,.noteh6,.warningh6{font-family:20036px'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.notep,.warningp{margin:.5em0}.note{color:black;background-color:#f0f6fb;border-left:4pxsolid#428bca}.noteh1,.noteh2,.noteh3,.noteh4,.noteh5,.noteh6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4pxsolid#c9302c}.warningh1,.warningh2,.warningh3,.warningh4,.warningh5,.warningh6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav.resource-group{padding:0}nav.resource-group.heading{position:relative}nav.resource-group.heading.chevron{position:absolute;top:12px;right:12px;opacity:.5}nav.resource-group.headinga{display:block;color:black;opacity:.7;border-left:2pxsolidtransparent;margin:0}nav.resource-group.headinga:hover{text-decoration:none;background-color:bad-color;border-left:2pxsolidblack}navul{list-style-type:none;padding-left:0}navula{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px12px;border-top:1pxsolid#d9d9d9;border-left:2pxsolidtransparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}navula:hover{text-decoration:none;background-color:bad-color;border-left:2pxsolidblack}navul>li{margin:0}navul>li:first-child{margin-top:-12px}navul>li:last-child{margin-bottom:-12px}navulula{padding-left:24px}navululli{margin:0}navululli:first-child{margin-top:0}navululli:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload*{transition:none!important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button.close{display:none;color:#428bca;cursor:pointer}.collapse-button.open{color:#428bca;cursor:pointer}.collapse-button.show.close{display:inline}.collapse-button.show.open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height.3sease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container.row.content{margin-left:244px;width:696px}.container.row:after{content:'';display:block;clear:both}.container-fluidnav{width:22%}.container-fluid.row.content{margin-left:24%}.container-fluid.triplenav{width:16.5%;padding-right:1px}.container-fluid.triple.row.content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.righta{color:#428bca}.righth1,.righth2,.righth3,.righth4,.righth5,.rightp,.rightdiv{color:white}.rightpre{background-color:#1d1f21;border:1pxsolid#1d1f21}.rightprecode{color:#c5c8c6}.right.description{margin-top:12px}.triple.resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition.method{font-weight:bold}.definition.method.get{color:#2e8ab8}.definition.method.head{color:#2e8ab8}.definition.method.options{color:#2e8ab8}.definition.method.post{color:#56b82e}.definition.method.put{color:#b8a22e}.definition.method.patch{color:#b8a22e}.definition.method.delete{color:#b82e2e}.definition.uri{word-break:break-all;word-wrap:break-word}.definition.hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names.tab-button{cursor:pointer;color:black;border:1pxsolid#ddd;padding:6px;margin-left:12px}.example-names.tab-button.active{background-color:#d5d5d5}.right.example-names{background-color:#444}.right.example-names.tab-button{color:white;border:1pxsolid#666;border-radius:6px}.right.example-names.tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1pxsolid#f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media(max-width:1200px){nav{width:198px}.container{max-width:840px}.container.row.content{margin-left:224px;width:606px}}@media(max-width:992px){nav{width:169.4px}.container{max-width:720px}.container.row.content{margin-left:194px;width:526px}}@media(max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container.row.content,.container-fluid.row.content,.container-fluid.triple.row.content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none!important;border-top:1pxsolid#d9d9d9;border-left:1pxsolid#d9d9d9;border-right:1pxsolid#d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1pxsolid#d9d9d9;border-radius:6px}.resource-grouph2.group-heading,.resource-group.headinga{padding:12px;margin:-12px-12px12px-12px;background-color:#f2f2f2;border-bottom:1pxsolid#d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple.content.resource-group{padding:0;border:none}.triple.content.resource-grouph2.group-heading,.triple.content.resource-group.headinga{margin:0012px0;border:1pxsolid#d9d9d9}nav.resource-group.headinga{padding:12px;margin-bottom:0}nav.resource-group.collapse-content{padding:0}.action{margin-bottom:12px;padding:12px12px012px;overflow:hidden;border:1pxsolidtransparent;border-radius:6px}.actionh4.action-heading{padding:6px12px;margin:-12px-12px12px-12px;border-bottom:1pxsolidtransparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.actionh4.action-heading.name{float:right;font-weight:normal;padding:6px0}.actionh4.action-heading.method{padding:6px12px;margin-right:12px;border-radius:3px;display:inline-block}.actionh4.action-heading.method.get{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.head{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.options{color:#fff;background-color:#337ab7}.actionh4.action-heading.method.put{color:#fff;background-color:#ed9c28}.actionh4.action-heading.method.patch{color:#fff;background-color:#ed9c28}.actionh4.action-heading.method.post{color:#fff;background-color:#5cb85c}.actionh4.action-heading.method.delete{color:#fff;background-color:#d9534f}.actionh4.action-headingcode{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.actiondl.inner{padding-bottom:2px}.action.title{border-bottom:1pxsolidwhite;margin:0-12px-1px-12px;padding:12px}.action.get{border-color:#bce8f1}.action.geth4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.headh4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.optionsh4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.posth4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.puth4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patchh4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.deleteh4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><bodyclass="preload"><ahref="#top"class="text-muted back-to-top"><iclass="fa fa-toggle-up"></i> Back to top</a><divclass="container"><divclass="row"><nav><divclass="resource-group"><divclass="heading"><divclass="chevron"><iclass="open fa fa-angle-down"></i></div><ahref="#upms">upms</a></div><divclass="collapse-content"><ul><li><ahref="#header-upms-user">upms user</a></li><li><ahref="#upms-user-page-get"><spanclass="badge get"><iclass="fa fa-arrow-down"></i></span>user page</a></li><li><ahref="#upms-create-user-post"><spanclass="badge post"><iclass="fa fa-plus"></i></span>create user</a></li><li><ahref="#upms-delete-user-post"><spanclass="badge post"><iclass="fa fa-plus"></i></span>delete user</a></li><li><ahref="#upms-update-user-post"><spanclass="badge post"><iclass="fa fa-plus"></i></span>update user</a></li></ul></div></div><pstyle="text-align: center; word-wrap: break-word;"><ahref="http://localhost:3000">http://localhost:3000</a></p></nav><divclass="content"><header><h1id="top">接口规范</h1></header><p>方便设计API的文档规范. For the rules used as a reference when building this application,
see <ahref="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p>
</span>}</code></pre><divstyle="height: 1px;"></div></div></div></div></div><divid="upms-delete-user"class="resource"><h3class="resource-heading">delete user <ahref="#upms-delete-user"class="permalink"> ¶</a></h3><divid="upms-delete-user-post"class="action post"><h4class="action-heading"><divclass="name">delete user</div><ahref="#upms-delete-user-post"class="method post">POST</a><codeclass="uri">/admin/user/delete/{id}</code></h4><p>用户删除</p>
<h4>Example URI</h4><divclass="definition"><spanclass="method post">POST</span> <spanclass="uri"><spanclass="hostname">http://localhost:3000</span>/admin/user/delete/<spanclass="hljs-attribute"title="id">90</span></span></div><divclass="title"><strong>URI Parameters</strong><divclass="collapse-button show"><spanclass="close">Hide</span><spanclass="open">Show</span></div></div><divclass="collapse-content"><dlclass="inner"><dt>id</dt><dd><code>int</code> <spanclass="required">(required)</span> <spanclass="text-muted example"><strong>Example: </strong><span>90</span></span><p>The id of the user.</p>
