https://github.com/mr-destructive/world-atlas-api
An API for World-Atlas Game, created using Django.
https://github.com/mr-destructive/world-atlas-api
api-rest django django-rest-framework python
Last synced: about 1 month ago
JSON representation
An API for World-Atlas Game, created using Django.
- Host: GitHub
- URL: https://github.com/mr-destructive/world-atlas-api
- Owner: Mr-Destructive
- Created: 2021-09-18T15:55:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T12:07:07.000Z (over 3 years ago)
- Last Synced: 2025-01-29T20:37:21.363Z (over 1 year ago)
- Topics: api-rest, django, django-rest-framework, python
- Language: Python
- Homepage: https://djangonaut.pythonanywhere.com/world-atlas/api/
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### An API for World Atlas - the geographical game.
You can check out and play the [World Atlas game](https://mr-destructive.github.io/WorldAtlas).
Currently it is implemented in without using this API, there are tons of Js hard coded arrays for that. That would be easy to exploit the game in a real-world scenario.
Soon, this API will be integrated into the app as well.
## API Endpoints
- **`'/'`** -> for validating the place.
- Returns `true` if the place exists in the database.
- Else returns `false` if it doesn't.
- **`'/get/'`** -> for obtaining an random place with given letter.
- Returns an place, beginning with the alphabet `letter`
- **`'/list/'`** -> Obtains a list of all places with given letter.
- Returns a list of places, beginning with the alphabet `letter`
- **`'/create/'`** -> Enters the place into database.
- Posts the entered place into the database.
