From 1c5cf336b270cdc96c0968eb36833d41383ac6af Mon Sep 17 00:00:00 2001 From: Stef Heyenrath Date: Sun, 6 Jan 2019 11:16:58 +0100 Subject: [PATCH] Updated Settings (markdown) --- Settings.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 62 insertions(+), 8 deletions(-) diff --git a/Settings.md b/Settings.md index 9063d56..ee45ca2 100644 --- a/Settings.md +++ b/Settings.md @@ -1,15 +1,22 @@ -# FluentMockServerSettings : generic settings -The class `FluentMockServerSettings` defines the settings which can be used to configure the WireMock.net server. +# FluentMockServerSettings +The interface [IFluentMockServerSettings.cs](https://github.com/WireMock-Net/WireMock.Net/blob/master/src/WireMock.Net/Settings/IFluentMockServerSettings.cs) defines the configuration from the WireMock.Net server. + +### Port +The port to listen on. + +### UseSSL +Use SSL. ### StartAdminInterface -defines to start the admin interface +Defines to if the admin interface should be started. -### AllowPartialMapping -defines if the matching should be done with exact matching or partial matching. **Partial matching** means that the best matching mapping is used for a input request. In case this setting is set to null or false, only **Exact matching** is done. This means that only when an exact 100% match is found for an input request, the response is handled. Else you get a error (404).| +### ReadStaticMappings +Defines if the static mappings should be read at startup. +### WatchStaticMappings +Watch the static mapping files + folder for changes when running. -# ProxyAndRecordSettings : Proxy and Record - +### ProxyAndRecordSettings You can enable ProxyAndRecord functionality by defining the *ProxyAndRecordSettings* and by specifying an Url. See code example below. ```c# @@ -34,4 +41,51 @@ Where * BlackListedHeaders = Defines a list from headers which will excluded from the saved mappings. ### Example: -When you a request like `localhost:9095/earth/story/20170510-terrifying-20m-tall-rogue-waves-are-actually-real`, this request is proxied to the `bbc.com` and the mapping definition is saved to `__admin\mappings\ab38efae-4e4d-4f20-8afe-635533ec2535.json`. \ No newline at end of file +When you a request like `localhost:9095/earth/story/20170510-terrifying-20m-tall-rogue-waves-are-actually-real`, this request is proxied to the `bbc.com` and the mapping definition is saved to `__admin\mappings\ab38efae-4e4d-4f20-8afe-635533ec2535.json`. + +### Urls +The URLs to listen on, if this is defined the port setting is not used. + +### StartTimeout +The StartTimeout from WireMock.Net, default 10 seconds. + +### AllowPartialMapping +Defines if the matching should be done with exact matching or partial matching. **Partial matching** means that the best matching mapping is used for a input request. In case this setting is set to null or false, only **Exact matching** is done. This means that only when an exact 100% match is found for an input request, the response is handled. Else you get a error (404). +This setting is default set to false. + +### AdminUsername +The username needed for __admin access. + +### AdminPassword +The password needed for __admin access. + +### RequestLogExpirationDuration +The RequestLog expiration in hours (optional). + +### MaxRequestLogCount +The MaxRequestLog count (optional). + +### PreWireMockMiddlewareInit +Action which is called (with the IAppBuilder or IApplicationBuilder) before the internal WireMockMiddleware is initialized. [Optional] + +### PostWireMockMiddlewareInit +Action which is called (with the IAppBuilder or IApplicationBuilder) after the internal WireMockMiddleware is initialized. [Optional] + +### IWireMockLogger +The [IWireMockLogger](https://github.com/WireMock-Net/WireMock.Net/blob/master/src/WireMock.Net/Logging/IWireMockLogger.cs) interface which logs Debug, Info, Warning or Error. + +By default this is implemented by a default console logger [WireMockConsoleLogger.cs](https://github.com/WireMock-Net/WireMock.Net/blob/master/src/WireMock.Net/Logging/WireMockConsoleLogger.cs). +But also a Null logger is available [WireMockNullLogger.cs](https://github.com/WireMock-Net/WireMock.Net/blob/master/src/WireMock.Net/Logging/WireMockNullLogger.cs). + + /// + /// Handler to interact with the file system to read and write static mapping files. + /// + [PublicAPI] + IFileSystemHandler FileSystemHandler { get; set; } + + + + + + +