https://github.com/piterden/crosswords-module

Streams Platform module for crosswords manage.
https://github.com/piterden/crosswords-module

api clues crossword search words

Last synced: 9 days ago
JSON representation

Streams Platform module for crosswords manage.

• Host: GitHub
• URL: https://github.com/piterden/crosswords-module
• Owner: Piterden
• Created: 2019-01-09T08:37:36.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-03T23:52:44.000Z (over 5 years ago)
• Last Synced: 2024-04-23T20:23:29.728Z (8 months ago)
• Topics: api, clues, crossword, search, words
• Language: PHP
• Size: 58.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Crossword Module

> The Streams Platform Addon

A backend implementation of words suggesting API. It is useful for help solving words for crossword puzzles.

## Features

- Masked queries

- Two languages support (RU/EN)

- Separately gets counts and data for each query

- ...

## Install

Coming soon...

## Usage

### CORS disabled mounts:

---

##### **`GET crossword/words/count/{mask}`**

##### **`GET crossword/words/en/count/{mask}`**

Receives a count of words matched with a given mask.

  

| Parameter | Type   | Default | Description                                                  |

| --------- | ------ | ------- | ------------------------------------------------------------ |

| `mask`    | string |         | Mask of a word, where all unknown letters replaced by underscores `_` |

---

##### **`GET crossword/words/find/{page}/{mask}`**

##### **`GET crossword/words/en/find/{page}/{mask}`**

Receives a list of words suggested to a given mask.

  

| Parameter | Type   | Default | Description                                                  |

| --------- | ------ | ------- | ------------------------------------------------------------ |

| `mask`    | string |         | Mask of a word, where all unknown letters replaced by underscores `_` |

| `page`    | number | 0       | Page number                                                  |

---

##### **`GET crossword/clues/find/{word}`**

##### **`GET crossword/clues/en/find/{word}`**

Receives a list of clues related with a given word.

  

| Parameter | Type   | Default | Description |

| --------- | ------ | ------- | ----------- |

| `word`    | string |         | A full word |

---

##### **`GET crossword/grids`**

Receives a list of available grids.

---

##### **`POST crossword/grids/create`**

Save a given grid to the database.

---

##### (WIP!!!) **`POST crossword/create`**

Creates a new empty crossword instance.

---