skyramp mocker generate rest
Generate mock configurations for REST protocol
Examples
skyramp mocker generate rest --api-schema https://example.com/api/v1/openapi.yaml --alias my-service --port 8080 --tag users --paths /api/v1/users
skyramp mocker generate rest --sample-response path/to/sample-response.json --alias my-service --port 8080 --endpoint-path
Options
--endpoint-path string the REST path that upgrades http to a websocket
-g, --glyphs string Specify the glyph combination to use: "1,2,3" - 1.Chinese 2.Cedilla 3.Emoji 4.Korean 5.German 6.French 7.Spanish 8.Russian 9.Control Char
--no-negative-scenarios disable generating negative mocks
--path strings REST path to filter on. Can be used multiple times to filter on multiple paths.
--paths string comma-separated list of REST paths to filter on (to be deprecated: use --path instead)
--tag
Options inherited from parent commands
--alias string Kubernetes service / Docker alias name
--api-schema string path to API schema file, or URL (URL support for OpenAPI 3.x only)
--kube-insecure enable insecure mode for interactions with Kubernetes clusters
--language string specify output language for Skyramp library code generation. Accepted values: "python" (default "YAML")
--openai (experimental) use OpenAI to generate mock values (the 'OPENAI_API_KEY' environment variable must be set with an OpenAI API token)
--openai-context string (experimental) Optional, extra context to give OpenAI to augment the mock values
--openai-model string (experimental) Optional, GPT model to use for OpenAI (one of [gpt-3.5-turbo gpt-4]). Note that some models may not accessible based on the API token (default "gpt-3.5-turbo")
--port int port number for the service
-p, --project-path string path to Skyramp project folder (default ".")
--sample-response string path to API sample response file
-v, --verbose count verbose (-v or -vv
See Also
generate - Generate mock configurations