https://github.com/lazorfuzz/gameofde_rest
Capstone project Flask REST API
https://github.com/lazorfuzz/gameofde_rest
Last synced: over 1 year ago
JSON representation
Capstone project Flask REST API
- Host: GitHub
- URL: https://github.com/lazorfuzz/gameofde_rest
- Owner: lazorfuzz
- Created: 2019-06-29T19:15:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T19:37:03.000Z (about 5 years ago)
- Last Synced: 2025-01-24T15:08:40.237Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 5.38 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gameofde_rest
Flask Rest API for Capstone project.
## Getting Started
```
pip3 install -r requirements.txt
python3 api.py
```
## Test Commands
Using [httpie](https://httpie.org/)
```python
# Getting organizations list:
http GET http://127.0.0.1:5000/orgs
# Creating a user:
http POST http://127.0.0.1:5000/create_account username="USERNAME" password="PASSWORD" email="EMAIL" role="admin"
# Logging in:
http POST http://127.0.0.1:5000/login username="USERNAME" password="PASSWORD"
# Submitting a cipher:
http POST http://127.0.0.1:5000/test_caesar cipher='hello' lang='en'
# Getting a specific organization:
http GET http://127.0.0.1:5000/orgs/NSA 'Authorization:AUTH_TOKEN_HERE'
# Creating a new organization:
http POST http://127.0.0.1:5000/orgs/GCHQ 'Authorization:AUTH_TOKEN_HERE'
```
## Unit tests
```python
python3 tests.py
```
## Documentation
Take a look at the [docs](docs.md)