Skip to content

A restful API using Falcon, SQLAlchemy, Marshmallow and MySQL. A model for restful API's.

Notifications You must be signed in to change notification settings

jshores281/Restful_API_model-1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RestFUL API model test

  • Standardized model for RESTful API design.

  • Template design of fully functioning restful api.

    • falcon, sqlalchemy, marshmellow, mysql.
  • The server will be compatible with either gunicorn or waitress


MECH:

  • - add a DB environment config file (allow different DB connectors)
  • - make DB function call reusable
  • - make OS agnostic

project structure:


:File system

│   app.py
│   middleware.py
│   __init__.py
│
├───engine
│       db_con.py
│       _config.env
│       __init__.py           
│
├───models
│       vault1_model.py
│       __init__.py
│   
├───resources
│       vault1_resource.py
│       __init__.py
│   
├───schemas
│       vault1_schema.py
│   
└───utils
        post_data.py
        req_data.py

:API routes

> falcon-inspect-app app:api

Falcon App (WSGI)
• Routes:
    ⇒ /vault1 - Vault1_resource:
       ├── GET - on_get
       └── POST - on_post
• Middleware (Middleware are independent):
    → Middleware.process_request

        ├── Process route responder

    ↢ Middleware.process_response


About

A restful API using Falcon, SQLAlchemy, Marshmallow and MySQL. A model for restful API's.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages