如何使用 nginx + uwsgi 部署 flask-restplus 应用程序

Question

我很难使用 Flask-Restplus 部署 Flask 应用程序。

在 http://localhost:5000/api 本地 (wezkrug) 工作时一切正常

但是当我使用 nginx + uwgsi 在机器上部署我的应用程序时，我在访问 http://example.com/api 时不断收到来自服务器的 404 响应...

看起来 Flask-Restplus 正在为 Swagger 使用 swaggerui...我是否必须在 nginx.conf 中添加一些东西来提供这个服务？原谅我的无知，但我以前没有使用过nginx的经验

这就是我声明包含 API 的蓝图的方式

# Configure the Blueprint for API
blueprint = Blueprint('api', __name__, url_prefix='/api')
api.init_app(blueprint)
api.add_namespace(programs_namespace)
api.add_namespace(students_namespace)
app.register_blueprint(blueprint)

这是我在 /etc/ngingx/conf.d/mysite.conf 中的 nginx 配置

server {
    listen       80;
    server_name  _;
    client_max_body_size 400M;

    location / {
        auth_basic "Restricted";
        auth_basic_user_file htpasswd;
        try_files $uri @app;
    }

    location /static/ {
        root /home/mysite/mysite/portal/src/portal; 
        access_log off;
        error_page 404 = @app;
        expires 7d;
    }

    location @app {
        include     uwsgi_params;
        uwsgi_pass  127.0.0.1:5000;
        access_log  /var/log/nginx/mysite_access.log main;
        error_log   /var/log/nginx/mysite_error.log warn;
    }
}

# SSL Server
server {
   listen               443 default_server ssl;
   client_max_body_size 400M;
   ssl_certificate      /etc/nginx/conf.d/mysite.crt;
   ssl_certificate_key  /etc/nginx/conf.d/mysite.key;    
   ssl_protocols  SSLv2 SSLv3 TLSv1;
   ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
   ssl_prefer_server_ciphers   on;
   keepalive_timeout    70;

   location / {
       auth_basic "Restricted";
       auth_basic_user_file htpasswd;
       try_files $uri @app;
   }

   location /static/ {
       root /home/mysite/mysite/portal/src/portal;
       access_log off;
       error_page 404 = @app;
       expires 7d;
   }
   location @app {
        include     uwsgi_params;
        uwsgi_pass  127.0.0.1:5000;
        access_log  /var/log/nginx/mysite_access.log main;
        error_log   /var/log/nginx/mysite_error.log warn;
    }
}

我必须说，当我尝试访问 http://example.com/api 时，我根本没有在日志文件中得到任何输出。

应用程序是通过使用 uwgsi 的 init 脚本运行的，您可以在此处查看内容：

mysite_dir=${mysite_DIR-/home/mysite/mysite/portal/src/portal}
pidfile=${PIDFILE-/var/run/mysite/mysite.pid}
uwsgi_bin=/usr/local/bin/uwsgi
uwsgi_url=127.0.0.1:5000
uwsgi_app=uwsgiapp
uwsgi_parameters="-p 4 -M -t 300"
logfile=${LOGFILE-/var/log/mysite.log}
user=mysite

chk_pidfolder() {
    [ -d "${pidfile%/*}" ] || install -o $user -g $user -d "${pidfile%/*}"
}

start() {
    log_daemon_msg "Starting mysite"
    start-stop-daemon --start -c $user -g $user --pidfile $pidfile --exec $uwsgi_bin -- --chdir $mysite_dir --pidfile $pidfile -s $uwsgi_url -w $uwsgi_app $uwsgi_parameters -d $logfile --callable app --enable-threads --post-buffering 4096
    log_end_msg $?
}   

stop () {
    log_daemon_msg "Stopping mysite"
    if [ -e "$pidfile" ]; then
        pid=`cat "$pidfile"`
    else
        pid=`pidofproc $uwsgi_bin`
    fi
    kill $pid
    stopped=false
    for ((i=0; i<10; i++)); do
        if [ -d /proc/$pid ]; then
            printf "."
            sleep 2
        else
            stopped=true
            break
        fi
    done
    if $stopped ; then
        rm -f $pidfile
        log_end_msg 0
    else
        kill -6 $pid
        log_warning_msg "no success, attempted to kill the process with -6, manual check recommended"
    fi
}

case "$1" in
    start)
        chk_pidfolder
        start
        ;;
    stop)
        stop
        ;;
    status)
        log_daemon_msg "Status of mysite"
        status_of_proc -p $pidfile $uwsgi_bin mysite
  #      if [ $? -eq 0 ]; then
  #        log_end_msg 0
  #        exit 0
  #      else
  #        log_end_msg 1
  #        exit 1
  #      fi
        ;;
    restart)
        log_daemon_msg "Restarting mysite"
        stop
        sleep 4
        start
        ;;
    *)
        echo $"Usage: $prog {start|stop|restart}"
        exit 2
        ;;
esac
exit 0

谢谢！

Answer 1

如Flask's documentation 中所述，您可能希望使用ProxyFix + 对您的 nginx 配置进行一些修改。

在您的应用程序代码中，您可能想要执行以下操作：

# Configure the Blueprint for API
blueprint = Blueprint('api', __name__, url_prefix='/api')
api.init_app(blueprint)
api.add_namespace(programs_namespace)
api.add_namespace(students_namespace)
app.register_blueprint(blueprint)

# Here we patch the application
from werkzeug.contrib.fixers import ProxyFix
app.wsgi_app = ProxyFix(app.wsgi_app)

那么你的 nginx 配置就得看看：

server {
    listen       80;
    server_name  _;
    client_max_body_size 400M;

    location / {
        auth_basic "Restricted";
        auth_basic_user_file htpasswd;
        try_files $uri @app;
    }

    location /static/ {
        root /home/mysite/mysite/portal/src/portal; 
        access_log off;
        error_page 404 = @app;
        expires 7d;
    }

    location @app {
        include     uwsgi_params;
        proxy_set_header   Host                 $host;
        proxy_set_header   X-Real-IP            $remote_addr;
        proxy_set_header   X-Forwarded-For      $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto    $scheme;
        uwsgi_pass  127.0.0.1:5000;
        access_log  /var/log/nginx/mysite_access.log main;
        error_log   /var/log/nginx/mysite_error.log warn;
    }
}

# SSL Server
server {
   listen               443 default_server ssl;
   client_max_body_size 400M;
   ssl_certificate      /etc/nginx/conf.d/mysite.crt;
   ssl_certificate_key  /etc/nginx/conf.d/mysite.key;    
   ssl_protocols  SSLv2 SSLv3 TLSv1;
   ssl_ciphers  ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
   ssl_prefer_server_ciphers   on;
   keepalive_timeout    70;

   location / {
       auth_basic "Restricted";
       auth_basic_user_file htpasswd;
       try_files $uri @app;
   }

   location /static/ {
       root /home/mysite/mysite/portal/src/portal;
       access_log off;
       error_page 404 = @app;
       expires 7d;
   }
   location @app {
        include     uwsgi_params;
        proxy_set_header   Host                 $host;
        proxy_set_header   X-Real-IP            $remote_addr;
        proxy_set_header   X-Forwarded-For      $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto    $scheme;
        uwsgi_pass  127.0.0.1:5000;
        access_log  /var/log/nginx/mysite_access.log main;
        error_log   /var/log/nginx/mysite_error.log warn;
    }
}