https://github.com/lukeuke/istaapi
Api made to search words which ends with words provided in url query from polish dictionary
https://github.com/lukeuke/istaapi
api dictionary nodejs
Last synced: about 2 months ago
JSON representation
Api made to search words which ends with words provided in url query from polish dictionary
- Host: GitHub
- URL: https://github.com/lukeuke/istaapi
- Owner: Lukeuke
- License: mit
- Created: 2022-05-20T18:07:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T18:07:39.000Z (almost 4 years ago)
- Last Synced: 2025-04-12T14:47:01.195Z (about 1 year ago)
- Topics: api, dictionary, nodejs
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IstaApi
Api made to search words which ends with provided ending in polish dictionary
## Installation
```console
git clone https://github.com/Lukeuke/IstaApi.git
```
```console
npm install
```
1. Rename file called '.env-example' to '.env'
1. In 'PORT=your_port_number' goes your port number
1. In 'HOST=ip_address' goes your host for example: localhost
1. To start the api type
```console
node app.js
```
## Endpoints
### Get
- /api?word=your_word
`Searches all the dictionary for specific ending of word`
### Post
- /dictionary
`Searches the definition of word provided in json from sjp.pl`
In request body you must provide json:
```json
{
"word" : "your_word"
}
```
Response:
```json
{
"description": "example_descritpion"
}
```
- /urban
`Searches definition, example and contributor of provided word from urandictionary.com`
`In request body you must provide:`
```json
{
"word" : "wtf"
}
```
Response:
```json
{
"description": "description for word",
"example": "example for word",
"contributor": "contributor for word"
}
```
## License
MIT