SignPuddle 3 Tools API


v3.0.0

tools

Resources related to tools

tools index

Get the tools index

REQUEST

RESPONSE

Headers
Content-Type text/plain
200 text/plain
                        Available routes:

/tools/
/tools/test{?text}
/tools/define
/tools/define/{section}
/tools/define/{section}/{part}
/tools/parse{?text,utf}
/tools/encode{?text,slash}
/tools/decode{?text}
/tools/utf8{?text}

                      
                        
                      
Character definition tree

The definition tree for character mapping

Get main define

REQUEST

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        {
  "utf-8": {},
  "utf-16": {},
  "utf-32": {},
  "fsw": {},
  "swu": {},
  "style": {}
}

                      
                        
                      
Section definition

A section of the definition tree

Get section define

REQUEST

Parameters
section string fsw

The name of section

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        {
  "sign": [],
  "spatial": [],
  "symbol": [],
  "coord": [],
  "prefix": [],
  "box": [],
  "query": []
}

                      
                        
                      
Part definition

A part of the section definition

Get part define

REQUEST

Parameters
section string swu

The name of section

part string symbol

The part of the definition

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        [
  "individual symbol",
  "S10000",
  "[\\x{40000}-\\x{4F428}]"
]

                      
                        
                      
Parse text

A function to analyze text and parse it into individual components

Get parse results

REQUEST

Parameters
text string S10000

The text to parse

utf string 32

The UTF number of 8, 16, 32 or ‘x’

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        {
  "fsw": {
    "symbol": [
      "S10000"
    ]
  },
  "query": {
    "base": [
      100
    ],
    "symbol": [
      "S10000"
    ]
  }
}

                      
                        
                      
Encode text

A function to encode SignWriting in Unicode (SWU) as UTF-16

Get encoded query string

REQUEST

Parameters
text string 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

The text to encode

slash number 1

The number of slashes for escaping

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        \uD836\uDC00\uD8D8\uDD31\uD8E2\uDC23\uD8F4\uDE61\uD836\uDC03\uD836\uDD1B\uD836\uDD35\uD8F4\uDE61\uD836\uDCF4\uD836\uDCF5\uD8D8\uDD31\uD836\uDD0C\uD836\uDD06\uD8E2\uDC23\uD836\uDD09\uD836\uDD1A

                      
                        
                      
Decode text

A function to decode SignWriting in Unicode (SWU) from UTF-16

Get decoded query string

REQUEST

Parameters
text string \uD836\uDC00

The text to decode

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        𝠀

                      
                        
                      
UTF-8 encode text

Get utf-8 encoded query string

REQUEST

Parameters
text string 𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚

The text to encode

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        %F0%9D%A0%80%F1%86%84%B1%F1%88%A0%A3%F1%8D%89%A1%F0%9D%A0%83%F0%9D%A4%9B%F0%9D%A4%B5%F1%8D%89%A1%F0%9D%A3%B4%F0%9D%A3%B5%F1%86%84%B1%F0%9D%A4%8C%F0%9D%A4%86%F1%88%A0%A3%F0%9D%A4%89%F0%9D%A4%9A

                      
                        
                      
Test with input

A general purpose function for testing

Get test results

REQUEST

Parameters
text string S10000

Input for testing

opt1 string AS

Option one for testing

opt2 string AS

Option two for testing

RESPONSE

Headers
Content-Type text/plain;charset=utf-8
200 text/plain;charset=utf-8
                        test output