Skip to content

Commit

Permalink
Add docs for configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
natenho committed Jun 11, 2023
1 parent ab57251 commit ef465a1
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 1 deletion.
4 changes: 4 additions & 0 deletions website/docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Configuration",
"position": 7
}
59 changes: 59 additions & 0 deletions website/docs/configuration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Configuration

The configuration can be made in the `appsettings.json` file inside `Settings` folder.

## `DefaultHttpStatusCode`

Set the default HTTP status code returned when the mock does not specify one.

Default: `OK` (200)

## `ErrorHttpStatusCode`

Set the default HTTP status code in case there is no matching mock available.

Default: `NotImplemented` (501)

## `DefaultHttpContentType`

Set the default HTTP `Content-Type` header response when the mock does not specify one.

Default: `application/json`

## `References`

A list of references to other .NET assemblies to extend scripting engine.

Default: `[]`

## `Imports`

A list of namespaces to be imported and made available in scripting engine.

Default: `[]`

## `MatchedRoutesCacheDuration`

Set the cache duration in minutes to be used by the verification endpoint.

## `MockacoEndpoint`

The exclusive endpoint to access internal features.

Default: `_mockaco`

## `VerificationEndpointName`

The name of the verification endpoint.

Default: `verification`

## `TemplateFileProvider`

Configure the mock template file provider.

### `Path`

Define the mock template files path.

Default: `Mocks`
2 changes: 1 addition & 1 deletion website/docs/verification/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You will be able to access the verification endpoint on ```http://localhost:5000

## Configure the duration of cache storing last request for verification

Each request with the exact time of being ivoked, body and path is being stored in the internal .Net cache for 60 minutes. You can configure this time by changing
Each request with the exact time of being invoked, body and path is being stored in the internal .Net cache for 60 minutes. You can configure this time by changing

```
"Mockaco": {
Expand Down

0 comments on commit ef465a1

Please sign in to comment.