Skip to content

Commit

Permalink
updating read me with some more fixes and additions
Browse files Browse the repository at this point in the history
  • Loading branch information
crowz-fx committed Nov 24, 2019
1 parent d526adb commit d8aff87
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# fx_api-http_status_codes
A python 3 webserver that serves up https status codes on RESTful endpoints. The API is driven by a Swagger definition that uses connexion to handle the mapping.
A Python webserver that serves up HTTP status codes on RESTful endpoints. The API is driven by a Swagger definition that uses connexion to handle the Swagger endpoint to the application endpoint.

Link to hosted...
- Information/entrypoint page --> [HERE][1]
- Swagger definition --> [HERE][2]

## Python version
Developed and run with Python3.7
Developed and run with Python3.7.

## Setup
To setup the environment you need to setup a virtual env using the following;
Expand All @@ -19,12 +23,14 @@ pip install -r requirements.txt
```

## Running the server
In order to run the server the following parameters can be accepted or omitted
In order to run the server the following parameters can be accepted or omitted in any combination;
```
# --debug-mode ;; default = false ;; will enable debugging of Flask, SQLAlchemy and SQLite
# --port=<int> ;; default = 5000 ;; take in the integer to run the application using that port
# --debug-mode ;; default = false ;; enable debugging of Flask, SQLAlchemy and SQLite
# --port=<int> ;; default = 5000 ;; integer to run the application using that port
# --host="<string>" ;; default = "0.0.0.0" ;; string to use as the host
python --debug-mode --port=<int> --host="<string>" server.py
```

[1]: https://crowzfx.co.uk/api/http-status/info
[2]: https://crowzfx.co.uk/api/http-status/v1/ui/

0 comments on commit d8aff87

Please sign in to comment.