start

honcho start -f local (use gunicorn)

Frest

Frest is the frame of the restful api server created with pallets/flask.

GOAL

Basic restful api server including login, sign up, sign out, modify account, writing, and etc..

Just modify app/config and python app.py runserver use it.

API

GET /api/v@/ Return environment, versions
POST /api/v@/auth Login
POST /api/v@/logout Sign out
GET /api/v@/users Get users with token and params: page(Default: 0), limit(Default: 10)
POST /api/v@/users Sign Up
GET /api/v@/users/<prefix(me or user_id)> Return user information
PUT /api/v@/users/<prefix(me or user_id)> Modify user information
DELETE /api/v@/users/<prefix(me or user_id)> Delete user
GET /api/v@/token?type=extension&token=<token> Token expire time extension
GET /api/v@/users/<prefix(me or user_id)>/login_histories Return Login histories with token and params: page(Default: 0), limit(Default: 10)

FUNCTION

Auto route loading app/routes
Decorating return values app/modules/frest/api
You can expire token with function app/models/user_token_model token_expire_all, token_expire_with_token

How to see apidoc

//install
npm install apidoc -g

//run
apidoc -i ./ -o ./apidoc

//in directory ./apidoc, apidoc will be generated