You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-33Lines changed: 33 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,11 +76,11 @@ my_microservice --help
76
76
### Parameters
77
77
78
78
The service requires the following configuration parameters:
79
-
-**`log_level`***(string)*: The minimum log level to capture. Must be one of: `["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "TRACE"]`. Default: `"INFO"`.
79
+
-<aid="properties/log_level"></a>**`log_level`***(string)*: The minimum log level to capture. Must be one of: `["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "TRACE"]`. Default: `"INFO"`.
80
80
81
-
-**`service_name`***(string)*: Short name of this service. Default: `"my_microservice"`.
81
+
-<aid="properties/service_name"></a>**`service_name`***(string)*: Short name of this service. Default: `"my_microservice"`.
82
82
83
-
-**`service_instance_id`***(string, required)*: A string that uniquely identifies this instance across all instances of this service. This is included in log messages.
83
+
-<aid="properties/service_instance_id"></a>**`service_instance_id`***(string, required)*: A string that uniquely identifies this instance across all instances of this service. This is included in log messages.
84
84
85
85
86
86
Examples:
@@ -90,13 +90,13 @@ The service requires the following configuration parameters:
90
90
```
91
91
92
92
93
-
-**`log_format`**: If set, will replace JSON formatting with the specified string format. If not set, has no effect. In addition to the standard attributes, the following can also be specified: timestamp, service, instance, level, correlation_id, and details. Default: `null`.
93
+
-<aid="properties/log_format"></a>**`log_format`**: If set, will replace JSON formatting with the specified string format. If not set, has no effect. In addition to the standard attributes, the following can also be specified: timestamp, service, instance, level, correlation_id, and details. Default: `null`.
@@ -111,31 +111,31 @@ The service requires the following configuration parameters:
111
111
```
112
112
113
113
114
-
-**`log_traceback`***(boolean)*: Whether to include exception tracebacks in log messages. Default: `true`.
114
+
-<aid="properties/log_traceback"></a>**`log_traceback`***(boolean)*: Whether to include exception tracebacks in log messages. Default: `true`.
115
115
116
-
-**`host`***(string)*: IP of the host. Default: `"127.0.0.1"`.
116
+
-<aid="properties/host"></a>**`host`***(string)*: IP of the host. Default: `"127.0.0.1"`.
117
117
118
-
-**`port`***(integer)*: Port to expose the server on the specified host. Default: `8080`.
118
+
-<aid="properties/port"></a>**`port`***(integer)*: Port to expose the server on the specified host. Default: `8080`.
119
119
120
-
-**`auto_reload`***(boolean)*: A development feature. Set to `True` to automatically reload the server upon code changes. Default: `false`.
120
+
-<aid="properties/auto_reload"></a>**`auto_reload`***(boolean)*: A development feature. Set to `True` to automatically reload the server upon code changes. Default: `false`.
121
121
122
-
-**`workers`***(integer)*: Number of workers processes to run. Default: `1`.
122
+
-<aid="properties/workers"></a>**`workers`***(integer)*: Number of workers processes to run. Default: `1`.
123
123
124
-
-**`api_root_path`***(string)*: Root path at which the API is reachable. This is relative to the specified host and port. Default: `""`.
124
+
-<aid="properties/api_root_path"></a>**`api_root_path`***(string)*: Root path at which the API is reachable. This is relative to the specified host and port. Default: `""`.
125
125
126
-
-**`openapi_url`***(string)*: Path to get the openapi specification in JSON format. This is relative to the specified host and port. Default: `"/openapi.json"`.
126
+
-<aid="properties/openapi_url"></a>**`openapi_url`***(string)*: Path to get the openapi specification in JSON format. This is relative to the specified host and port. Default: `"/openapi.json"`.
127
127
128
-
-**`docs_url`***(string)*: Path to host the swagger documentation. This is relative to the specified host and port. Default: `"/docs"`.
128
+
-<aid="properties/docs_url"></a>**`docs_url`***(string)*: Path to host the swagger documentation. This is relative to the specified host and port. Default: `"/docs"`.
129
129
130
-
-**`cors_allowed_origins`**: A list of origins that should be permitted to make cross-origin requests. By default, cross-origin requests are not allowed. You can use ['*'] to allow any origin. Default: `null`.
130
+
-<aid="properties/cors_allowed_origins"></a>**`cors_allowed_origins`**: A list of origins that should be permitted to make cross-origin requests. By default, cross-origin requests are not allowed. You can use ['*'] to allow any origin. Default: `null`.
@@ -148,13 +148,13 @@ The service requires the following configuration parameters:
148
148
```
149
149
150
150
151
-
-**`cors_allow_credentials`**: Indicate that cookies should be supported for cross-origin requests. Defaults to False. Also, cors_allowed_origins cannot be set to ['*'] for credentials to be allowed. The origins must be explicitly specified. Default: `null`.
151
+
-<aid="properties/cors_allow_credentials"></a>**`cors_allow_credentials`**: Indicate that cookies should be supported for cross-origin requests. Defaults to False. Also, cors_allowed_origins cannot be set to ['*'] for credentials to be allowed. The origins must be explicitly specified. Default: `null`.
@@ -167,15 +167,15 @@ The service requires the following configuration parameters:
167
167
```
168
168
169
169
170
-
-**`cors_allowed_methods`**: A list of HTTP methods that should be allowed for cross-origin requests. Defaults to ['GET']. You can use ['*'] to allow all standard methods. Default: `null`.
170
+
-<aid="properties/cors_allowed_methods"></a>**`cors_allowed_methods`**: A list of HTTP methods that should be allowed for cross-origin requests. Defaults to ['GET']. You can use ['*'] to allow all standard methods. Default: `null`.
@@ -187,15 +187,15 @@ The service requires the following configuration parameters:
187
187
```
188
188
189
189
190
-
-**`cors_allowed_headers`**: A list of HTTP request headers that should be supported for cross-origin requests. Defaults to []. You can use ['*'] to allow all headers. The Accept, Accept-Language, Content-Language and Content-Type headers are always allowed for CORS requests. Default: `null`.
190
+
-<aid="properties/cors_allowed_headers"></a>**`cors_allowed_headers`**: A list of HTTP request headers that should be supported for cross-origin requests. Defaults to []. You can use ['*'] to allow all headers. The Accept, Accept-Language, Content-Language and Content-Type headers are always allowed for CORS requests. Default: `null`.
@@ -205,7 +205,7 @@ The service requires the following configuration parameters:
205
205
```
206
206
207
207
208
-
-**`generate_correlation_id`***(boolean)*: A flag, which, if False, will result in an error when inbound requests don't possess a correlation ID. If True, requests without a correlation ID will be assigned a newly generated ID in the correlation ID middleware function. Default: `true`.
208
+
-<aid="properties/generate_correlation_id"></a>**`generate_correlation_id`***(boolean)*: A flag, which, if False, will result in an error when inbound requests don't possess a correlation ID. If True, requests without a correlation ID will be assigned a newly generated ID in the correlation ID middleware function. Default: `true`.
209
209
210
210
211
211
Examples:
@@ -220,7 +220,7 @@ The service requires the following configuration parameters:
220
220
```
221
221
222
222
223
-
-**`language`***(string)*: The language. Must be one of: `["Greek", "Croatian", "French", "German"]`. Default: `"Croatian"`.
223
+
-<aid="properties/language"></a>**`language`***(string)*: The language. Must be one of: `["Greek", "Croatian", "French", "German"]`. Default: `"Croatian"`.
224
224
225
225
226
226
### Usage:
@@ -274,8 +274,8 @@ Then open this repository in VS Code and run the command
274
274
This will give you a full-fledged, pre-configured development environment including:
275
275
- infrastructural dependencies of the service (databases, etc.)
276
276
- all relevant VS Code extensions pre-installed
277
-
-preconfigured linting and auto-formatting
278
-
- a preconfigured debugger
277
+
-pre-configured linting and auto-formatting
278
+
- a pre-configured debugger
279
279
- automatic license-header insertion
280
280
281
281
Moreover, inside the devcontainer, a command `dev_install` is available for convenience.
0 commit comments