mohit11r / planetary-api

It is Planetary Restful API using Flask

Planetary API 🌏

---

Overview

1. Build a Restful API using Flask for Web app , Mobile app, Desktop app.
2. Testing of API is done by using POSTMAN application and soon will be done by automation scripts using selenium , unittest libraries.
3. For this API Database is SQLAlchemy. It is easy to use.

---

Prerequisite

• Python
• SQL Database
• JSON
• OS library

---

File Structure

Planetary API
    ├── app.py
    ├── doc.txt
    ├── planets.db
    ├── requirements.txt
    

---

API Features

1. List all known planets
2. Register new Users
3. Authenticate existing users
4. Add new planetary discoveries to the database
5. Update existing planetary data
6. Delete planets when necessary

---

Benefits of an ORM (Object–relational mapping)

1. Works with Python objects, not SQL.
2. Allows you to switch your database easily.
3. You can control the structure of your database from your code, which can be managed by a revision control system like Git.
4. Supports multiple databases platforms.

---

Securing API

1. Securing Your API with JSON Web Tokens (JWTs)
2. Flask-Mail -- for Email
3. Flask-Login -- For Login
4. Flask-User -- For User

---

ORM Tool

1. Marshmallow is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
2. Flask-Marshmallow is a thin integration layer for Flask and marshmallow that adds additional features to marshmallow.
3. marshmallow-sqlalchemy An SQLAlchemy integration with the marshmallow (de)serialization library.