Skip to content

Corrected the header attributes. #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swapnanildutta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Corrected the header attributes. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ The POST is authenticated using an API Key as a parameter.
Where the key is stored in a file, so the key value is not stored in code.
Be sure to change the value in api.key when deploying.

##Installation
####Dependencies
## Installation

#### Dependencies
1. Python 2 or 3
2. Flask
3. virtualenv

####Setup
#### Setup
```
$ cd flask-api-key
$ virtualenv venv
Expand All @@ -26,7 +27,7 @@ $ flask run
* Running on https://127.0.0.1:443/ (Press CTRL+C to quit)
```

##GET Test
## GET Test
```
curl -k https://127.0.0.1
Hellow world!
Expand All @@ -36,8 +37,8 @@ Flask server output:
127.0.0.1 - - [23/Oct/2016 14:55:55] "GET / HTTP/1.1" 200 -
```

##POST Tests
###Key in header
## POST Tests
### Key in header
```
$ curl -k -H "Content-Type: application/json" -H "x-api-key: eiWee8ep9due4deeshoa8Peichai8Ei2" -X POST -d '{"username":"xyz","password":"xyz"}' https://127.0.0.1/json/
Posted JSON!
Expand All @@ -47,7 +48,7 @@ Flask server output:
127.0.0.1 - - [23/Oct/2016 14:55:26] "POST /json/ HTTP/1.1" 200 -
```

###Key in argument
### Key in argument
```
curl -k -H "Content-Type: application/json" -X POST -d '{"username":"xyz","password":"xyz"}' https://127.0.0.1/json/?key=eiWee8ep9due4deeshoa8Peichai8Ei2
Posted JSON!
Expand Down