Difference between revisions of "W3911 Sudoku Server"

Revision as of 07:42, 7 October 2021

Within these castle walls be forged Mavens of Computer Science ...

— Merlin, The Coder

Background A Sudoku board is made up of nine boxes. Boxes (container for nine cells) are listed from top-to-bottom, left-to-right indexed from zero. Cells are listed from top-to-bottom, left-to-right, indexed from zero. All valid payloads and responses must use well-formed JSON. “cells” is returned as follows: “cells”: [[<nine values from top-left>], [<nine values from top-middle>], …]

End Points

POST /games?difficulty=<difficulty>
Creates a new game and associated board

   Parameters: 
   difficulty: easy | medium | hard | hell

   Body: none

   Status code: 201 Created

   Response: ID (integer) of newly created game
   {"id":<id>}
   
   {"id": 728134}

   Errors:
   
   {{{errors}}}

GET /games/<id>/cells
Returns the current cells for the specified game

   Parameters: 
   none

   Body: none

   Status code: 200 OK

   Response: Cells
   {"id":<id>}
   
   {"id": 728134}

   Errors:
   
   {{{errors}}}

PUT /games/<id>/cells/<boxIndex>/<cellIndex>

   * Action: Place specified value at in game at boxIndex, cellIndex
   * Payload: value (null for removing value)
   * Response: Nothing
   * Status: 204 No Content

JSON Encoding[edit]

JSON Decoding[edit]

Issue Request from Client to Server[edit]

import Foundation                                                                                                                                                                                                                           
import FoundationNetworking                                                                                                                                                                                                                 
 
// Form the request                                                                                                                                                                                                                                           
var request = URLRequest(url: URL(string: "https://language-server.codermerlin.com/now")!)                                                                                                                                                  
request.httpMethod = "GET"

// Execute synchronously (uses extension in code below)                                                                                                                                                                                                                 
let (data, response, error) = URLSession.shared.syncRequest(with: request)
if let data = data,                                                                                                                                                                          
   let string = String(data: data, encoding: .utf8) {                                                                                                                                     
   print(string)                                                                                                                                                                            
} else if let error = error {
    print("Error: \(error)")
} else {
    print("An unexpected error occurred.")
}

// Reference: https://stackoverflow.com/questions/26784315/can-i-somehow-do-a-synchronous-http-request-via-nsurlsession-in-swift
extension URLSession {
   func syncRequest(with request: URLRequest) -> (Data?, URLResponse?, Error?) {
      var data: Data?
      var response: URLResponse?
      var error: Error?
      
      let dispatchGroup = DispatchGroup()
      let task = dataTask(with: request) {
         data = $0
         response = $1
         error = $2
         dispatchGroup.leave()
      }
      dispatchGroup.enter()
      task.resume()
      dispatchGroup.wait()
      
      return (data, response, error)
   }  
}

@@ Line 9: / Line 9: @@
 End Points
-* POST /games?difficulty=<difficulty>
+{{RestAPI
-    * Action: Creates a new game and associated board
+|endpoint=POST /games?difficulty=<difficulty>
-    * Parameters:
+|action=Creates a new game and associated board
-      * difficulty: easy|medium|hard|hell
+|parameters=difficulty: easy {{Bar}} medium {{Bar}} hard {{Bar}} hell
-    * Payload: None
+|body=<span style="font-style: italic;">none</span>
-     * Response: Id uniquely identifying a game
+|statusCode=201 Created
-    * Status code: 201 Created
+|response=ID (integer) of newly created game
-* GET /games/<id>/cells
+     {"id":<id>}
-    * Action: None
+|responseExample={"id": 728134}
-    * Payload: None
+}}
-     * Response: cells
+{{RestAPI
-    * Status code: 200 OK
+|endpoint=GET /games/<id>/cells
+|action=Returns the current cells for the specified game
+|parameters=<span style="font-style: italic;">none</span>
+|body=<span style="font-style: italic;">none</span>
+|statusCode=200 OK
+|response=Cells
+     {"id":<id>}
+|responseExample={"id": 728134}
+}}
 * PUT /games/<id>/cells/<boxIndex>/<cellIndex>
      * Action: Place specified value at in game at boxIndex, cellIndex