A simple and dummy REST API written in Python using Flask, Peewee and Marshmallow.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Samy Delahaye 196e74d61c Update 'README.md' 1 year ago
hello_api Splitting APIModelMixin into three mixin for more explicit usage 1 year ago
static Splitting APIModelMixin into three mixin for more explicit usage 1 year ago
templates Initial commit 1 year ago
.gitignore Initial commit 1 year ago
Pipfile Adding basic tests 1 year ago
Pipfile.lock Adding basic tests 1 year ago
README.md Update 'README.md' 1 year ago
app.py Database init is modulare for some testing 1 year ago
tests.py Adding basic tests 1 year ago

README.md

HelloAPI

A simple and dummy REST API written in Python using Flask, Peewee and Marshmallow.

Quickstart

Grab the code

$ git clone https://sources.delahayeyourself.info/sdelahaye/HelloAPI.git

Setup dev env

$ pipenv --python 3
$ pipenv install

Init database and start server

$ flask initdb --populate-fake-data true
$ flask run

Perform your first request with curl

$ curl http://127.0.0.1:5000/api/automotives/certificates/

UML Diagramm

Database

Uml diagram database

Class

Uml diagram

Requirements

flask
peewee
faker
marshmallow

Testings ?

Coverage is minimal but enough for learning some test unit in python with pytest

pytest tests.py

Purpose

This project is only for educational purpose. It's actually a basic application for generating a dummy REST API.

Authors

Samy Delahaye