https://github.com/edumigueis/simple-flask-api
An ultra simple flask API template. It returns static JSON, and was made as a first experiment with flask.
https://github.com/edumigueis/simple-flask-api
api flask flask-api flask-restful python python3 rest-api
Last synced: about 1 month ago
JSON representation
An ultra simple flask API template. It returns static JSON, and was made as a first experiment with flask.
- Host: GitHub
- URL: https://github.com/edumigueis/simple-flask-api
- Owner: edumigueis
- License: mit
- Created: 2020-08-13T21:33:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T16:24:48.000Z (over 4 years ago)
- Last Synced: 2025-02-01T21:34:27.302Z (3 months ago)
- Topics: api, flask, flask-api, flask-restful, python, python3, rest-api
- Language: Python
- Homepage:
- Size: 6.95 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple-Flask-API
>An ultra simple flask API template. It returns static JSON, and was made as a first experiment with flask.
This API was built using Python and Flask. It uses as an example a static to do list in JSON format.
## Installation
First, download the project and:
```sh
cd simple-flask-API
```
Check if you have python and pip installed in your computer. Then you have to create a virtual environment to run flask.
```sh
pip install flask
py -m venv venv
```
Then:
```sh
flask run
```
## Usage example
This is just a slim and simple template that can be used as a starter to your flask project. Any changes can be made as you wish. This is a simple application so that any other flask API can grow from. So, if you want an API that returns static data back, it's a great starter. Or, if you would like to add a database, it can be easily done in this template.
## Meta
Eduardo Migueis -
Distributed under the MIT license. See ``LICENSE`` for more information.
[https://github.com/edumigueis/Simple-Flask-API](https://github.com/edumigueis/)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[npm-url]: https://npmjs.org/package/datadog-metrics
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
[wiki]: https://github.com/yourname/yourproject/wiki