Code Monkey home page Code Monkey logo

api's Introduction

pythonORM

1) models

from app import db
from app.models.base_entity import BaseEntity

class Role(BaseEntity, db.Model):
    __tablename__ = "roles"
    roleid = db.Column(db.Integer, primary_key=True)
    rolename = db.Column(db.String(50), nullable=False, unique=True, index=True)
        self.data = data

1.2) relationship one to many

class Parent(BaseEntity, db.Model):
    __tablename__ = "parents"
    parentid = db.Column(db.Integer, primary_key=True)
    childid = db.Column(db.ForeignKey('children.childid'))
    children = db.relationship("Child", cascade='all, delete-orphan')
    
class Child(BaseEntity, db.Model):
    __tablename__ = "children"
    childid = db.Column(db.Integer, primary_key=True)
    parent = db.relationship("User", back_populates="children")

2) formulares

class ExampleForm(FlaskForm):
    # désactiver CSRF pour les api
    class Meta:
        csrf = False
    exampleData = StringField('exampleData', validators=[])
    exampleData2 = StringField('exampleData2', validators=[DataRequired()])

3) mappers

Créer les mapper pour passer des entités au dtos, et mettre à jours les entité 
à partir des forms.

4) services

- des fonctions pour contacter la db : 
    - findOne => retourne une entité en fonction de son id
    - findOneBy => retourne une entité en fonction d'un 
        paramètre passé (données d'une des colonnes)
    - findAll => retourne toutes les data
    - update => met à jours les donnés en DB
    - insert => insert des nouvelles donnée en DB
    - delete => delete une entrée en DB

5) controllers

class ExampleController:
    # http://servername/path
    @app.route('/path', methods=['GET', 'POST'])
    def getAllData():
        return jsonify([example.get_json_parseable() for example in service.findAll()])
    # http://servername/path/1
    @app.route('/path/<int:dataid>', methods=['GET', 'POST'])
    def getAllData(dataid):
        return jsonify(service.findOne().get_json_parseable())

6) Dépendence

les mappers dépendent des modèles, des DTOs et des forms
les services dépendent des modèles et des mappers
les controllers dépendent des services.

7) database

la connection string doit être modifiée dans le .env ou .env.local
pour initialiser la db utiliser :
    $ ./sqlAlchemy.sh -i
    
pour créer de nouvelles migrations :
    $ ./sqlAlchemy.sh -m nom_de_la_migration
    
Le fichier de la migration peut être modifier si nécéssaire pour mettre à jours ou rajouter 
des données dans la DB.

une fois les migrations créées on peut les appliquer avec la commande :
    $ ./sqlAlchemy.sh -u

8) lancer le serveur

$ python3 runserver.py

pour lancer le serveur en debug depuis votre ide, il faudra soit créer un launch.json
via l'onglet de debugging de VSCode.
Soit on peut créer une nouvelle configuration de debugging dans Pycharm et mettre le runserver.py
comme programme de lancement.

api's People

Contributors

murakamiko avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.