From 385bbcf8d3490a7ccc3ff939e7bc8752b7fb5923 Mon Sep 17 00:00:00 2001 From: Zackary Troop Date: Thu, 8 Feb 2024 21:46:08 -0500 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e652a12..9cdda3f 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,18 @@ Options: -V, --version Print version ``` -### Configuration File Example +## Configuration + +Each item in the list (denoted by a dash -) represents a configuration for an API endpoint. Each endpoint configuration consists of several key-value pairs that define its properties. Here's what each key represents: + +- `name` - A human-readable identifier for the endpoint. It's used for reference and doesn't affect the endpoint's functionality. +- `endpoint` - The URI path that the endpoint responds to. This is the part of the URL that follows your domain or base URL. +- `method` - (Optional) Specifies the HTTP method (e.g., GET, POST) the endpoint should respond to. It defines the type of operation you want to perform. +- `data` - (Optional) Contains the data that the endpoint will send back in the response. This section is structured as nested key-value pairs, representing the response body. It's typically used with methods like POST or PUT that involve sending data. +- `status` - The HTTP status code that the endpoint will return. It indicates the result of the request (e.g., 200 for success, 404 for not found). +- `headers` - (Optional) Specifies any additional HTTP headers that the response will include. Headers are often used for specifying the content type or for authentication. + +### File Example ```yaml - name: "Example Endpoint 1"