Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tino097/examples-flask-rest-api

:sunny: :star: :star: Flask REST API :star: :star: :sunny:
https://github.com/tino097/examples-flask-rest-api

List: examples-flask-rest-api

flask flask-api python

Last synced: 13 days ago
JSON representation

:sunny: :star: :star: Flask REST API :star: :star: :sunny:

Awesome Lists containing this project

README

        

# Examples Flask Rest API

[![Wercker](https://img.shields.io/badge/python-v3.8-green.svg?style=flat-square&logo=python)](https://python.org)
[![Wercker](https://img.shields.io/badge/flask-v1.1.1-green.svg?style=flat-square&logo=flask)](https://flask.palletsprojects.com/en/1.1.x/)
[![Wercker](https://img.shields.io/badge/restix-v0.1.1-green.svg?style=flat-square&logo=flask)](https://flask-restx.readthedocs.io/en/latest/)

## Requirements

Create REST application where we can give an example of CRUD operations and best practices for mostly used languages and frameworks

The app, called CompanyRegister should be able to:

- Add new company ---> _**C**reate_
- List all companies ---> _**R**etreive_
- Update a company ---> _**U**pdate_
- Delete a company ---> _**D**elete_

# Flask API

[Flask](https://www.palletsprojects.com/p/flask/) is realy super-easy and lightweight web appliations framework. If you are familiar with any other framework, transition to Flaks is matter of hours and even it is really simple to learn for beginers.

In addition for the example I will use [Flask-RESTIX](https://flask-restx.readthedocs.io/en/latest/) extension. The extension encourages best practices with minimal setup.

## Project setup