Skip to content

Fake-API-Server setting

fake-api-server

The detail settings about how PyFake-API-Server-Surveillance should run with PyFake-API-Server. Recently, it only supports setting with subcommand line pull.

server-type

Which server type it should use to identify the target API server configuration.

🚧 Not totally complete

Currently, it only supports rest-server.

subcmd

This section is responsible for the specific subcommand line setting.

subcmd.<subcommand line>

Which subcommand line for customizing settings. Please refer to command line details of PyFake-API-Server to set value.

subcmd.<subcommand line>.args

Customize which arguments should use in running the subcommand line. Please refer command line details to set the command line options of the specific subcommand line.

Here is a demonstration and how it would transfer as command line

Let's give a sample configuration with section subcmd:

1
2
3
4
5
6
7
8
subcmd:
  pull:
    args:
      - --config-path=./sample-api.yaml
      - --include-template-config
      - --base-file-path=./
      - --base-url=/test/v1
      - --divide-api

It customizes how PyFake-API-Server-Surveillance should run the program with the specific options under subcommand line pull.

So above setting also could translate as command line as following:

>> fake rest-server pull \
    --config-path=./sample-api.yaml \
    --base-file-path=./ \
    --include-template-config \
    --base-url=/test/v1 \
    --divide-api