https://github.com/app-generator/devtool-flask-api-generator

Flask API Generator - Open-Source Tool for Developers | AppSeed
https://github.com/app-generator/devtool-flask-api-generator

api-generator appseed flask open-source

Last synced: 10 days ago
JSON representation

Flask API Generator - Open-Source Tool for Developers | AppSeed

• Host: GitHub
• URL: https://github.com/app-generator/devtool-flask-api-generator
• Owner: app-generator
• License: other
• Created: 2022-09-16T05:55:42.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T13:08:03.000Z (about 2 years ago)
• Last Synced: 2024-10-11T04:43:31.101Z (about 1 month ago)
• Topics: api-generator, appseed, flask, open-source
• Language: SCSS
• Homepage: https://appseed.us
• Size: 25.2 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - app-generator/devtool-flask-api-generator - Flask API Generator - Open-Source Tool for Developers | AppSeed (SCSS)

README

        
# Flask API Generator

The tool is able to generate APIs using Flask, Flask-RestX stack with a minimum effort. For newcomers, Flask is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions.

- 👉 Free [support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup)

- 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed




## Video Presentation

https://user-images.githubusercontent.com/51070104/194278839-8ea8e6e1-5ce9-4c53-9b8a-442a208c46d3.mp4




## How It Works

This module helps to generate secure APIs using `Flask-restX` via a simple workflow: 

- Edit/add your model in `apps/models.py`

- Migrate the database:

```bash

$ flask db init     # this should be executed only once

$ flask db migrate  # Generates the SQL 

$ flask db upgrade  # Apply changes 

```

- Update Configuration:

  - `apps/config .py`, section `API_GENERATOR` 

- Generate the API code:

  - `$ flask gen_api`        # the new code is saved in `apps/api`

- Access the API in the browser:

  - `/api/MODEL_NAME/`

The API is secured using the JWT tocken provided by `/login/jwt/` request (username & password should be provided).  

- GET requests are public (GET all, get Item)

- Mutating requests are protected by token generated based on the user credentials (`username`, `pass`). 

> Two POSTMAN Collections are provided in the `media` directory: 

- [Books API](./media/api-books.postman_collection) - that uses PORT **5000* for the api

- [Books API 2](./media/api-books-docker.postman_collection) - that uses PORT **5085* for the api (default port in Docker)

In case both port are unusable in your environment, feel free to edit the files before POSTMAN import.




--- 

**Flask API Generator** - Developer tool provided by [AppSeed](https://appseed.us)