– Hemlig kodbok för utvecklare –

API

JSON-API. Svar cachas i en vecka. CORS är på.

Bas-URL

https://rovarspraket.tammergard.se/api/v1

Endpoints

GET/api/v1/to/{text}

Översätt vanlig text till rövarspråket.

Exempel:

https://rovarspraket.tammergard.se/api/v1/to/hej

Svar:

{
  "text": "hej",
  "robber": "hohejoj"
}

GET/api/v1/from/{robber}

Översätt en rövarspråkssträng tillbaka till vanlig text.

Exempel:

https://rovarspraket.tammergard.se/api/v1/from/hohejoj

Svar:

{
  "robber": "hohejoj",
  "text": "hej"
}

Notera: eftersom "x" och "ks" båda kodas till samma rövarspråk-utdata ger avkodningen alltid tillbaka "ks". Det är en grundläggande egenskap hos rövarspråket, inte en bugg.

GET/api/v1/validate/{robber}

Kolla om en sträng är giltigt rövarspråk.

Exempel:

https://rovarspraket.tammergard.se/api/v1/validate/hohejoj

Svar:

{
  "input": "hohejoj",
  "valid": true
}

Fel

Fel returneras som JSON. Statuskoder:

400 – parameter saknas (tom sträng).
422 – välformad indata men ogiltig (/from med en sträng som inte är rövarspråk).

{
  "error": {
    "status": 422,
    "message": "\"bod\" är inte en giltig rövarspråkssträng."
  }
}

Vill du bygga med rövarspråket själv?

Funktionerna bakom API:t finns som ett npm-paket: @tammergard/robber. Det exponerar toRobber, fromRobber och pattern.

Bakgrunden finns att läsa i blogginlägget Rövarspråksgenerator.