flask-restful-boilerplate

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #golang #go #rust #macos #cli #kubernetes #pytorch #security #ios #mcp

flask-restful-boilerplate

(★ 14)

A minimal boilerplate for the RESTful services using Flask, SQLAlchemy and Flask-RestPlus (for the swagger-UI).

flask-restful-boilerplate 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# flask-restful-boilerplate
A minimal boilerplate for creating RESTful services using Flask, SQLAlchemy and Flask-RestPlus. This boilerplate has swagger-UI) [for personal use]

## What it includes?
- capabilities of establishhing connection to any database using `SQLAlchemy`.
- a `service logger` for logging all the events, warnings, errors, etc.
- a placeholder for declaring all your `constants`.
- a placeholder for all your declared `database models`.
- entire codeset is config-driven.
- hosting of `swagger-UI` for your RESTful API's documentation.
- hosting `multiple namespaces` in the routes.
- a `custom response generator` for the payloads.

## Setting up:
- install all the requirements from `requirements.txt`<br>
```pip install -r requirements.txt```
- make necessary changes in `config.ini`
  - add `host` address (default="127.0.0.1")
  - add `port` address (default=5000)
  - set a `name` for the flask restful service (default="flask-minimal-boilerplate")
  - add the `database url` (default="postgresql://scott:tiger@localhost/sample_db")
- create a directory called **logs** in the current working directory. This is where all your log fiels will be stored.

## Running the program:
- after having setup everything above, run the program using 
```python
python run.py
```

flask-restful-boilerplate

flask-restful-boilerplate 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

flask-restful-boilerplate

flask-restful-boilerplate 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README