Skip to content

Subcommand run usage

Activate and run a web server which could provide all the APIs be configured in .yaml configuration file. The way for running the web server would be different if the web library is different so that the log message would be different.

>>> fake rest-server run <option>

--config or -c <config-file-path>

Set the configuration file path. PyFake-API-Server would use the settings to configure the APIs.

It receives a value about the configuration file path and its default value is api.yaml.

--app-type <Python-web-library>

Set one of Python web framework which would be the code base of the web server for mocking APIs.

It receives a value about the Python web framework. The options it accepts are auto, flask and fastapi.

  • auto

    It would automatically detect which Python web framework it could use in current runtime environment. If it doesn't have any web framework could use, it would exit the program finally.

  • flask

    Use Python web framework Flask to be the code base of the web server for mocking APIs.

  • fastapi

    Use Python web framework FastAPI to be the code base of the web server for mocking APIs.

Its default value is auto.

--bind or -b <host-address>

Set the host to bind with the web server.

It receives a value about the host address which should includes IP address and port. Its default value is 0.0.0.0:9672.

Why the default port is 9672?

The port number could be divides into 2 parts: 96 and 72. These 2 number mean an important thing in history: In 1996, the NBA G.O.A.T Michael Jordan leaded the Chicago Bulls team won 72 games and won the NBA champion in that season finally. He has keeped making history and has so many unbelievable records in NBA history. Therefore, PyFake-API-Server uses the port number 9672 to remember the things this legend made.

--workers or -w <workers>

Set the amount how many workers does it process the requests of web server.

It receives a value about the amount of workers and its default value is 1.

--log-level <level>

Set the log level of web server what info it should export.

It receives a value about the log level and its default value is info.

--daemon or -D

Daemonize the fake server process to run it in background.

It doesn't accept any value and default is False. It's True if set this option.

New in version 0.4.1

--access-log-file <log file path>

Set the file path which program will write the fake server access log to. This option would be truly activated when the option --daemon also be used.

It receives a value about the log file path which program will write the log messages to. Its default value is fake-api-server.log.