Web

The web session brings together the settings, such as the exposed endpoints, Swagger activation, default HTTP error codes, the display of HTTP request details, and the handling of invalid requests (BadRequest).

You can enable or disable the adapter, set an http exposure port, enable swagger in the development environment, and set default http error codes for return in the API’s. If you wish, you can add a custom http error code directly in the API.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
  "DevPrime_Web": {
    "url": "https://localhost:5001;http://localhost:5000",
    "enable": "true",
    "enableswagger": "true",
    "PostSuccess": "201",
    "PostFailure": "500",
    "GetSuccess": "200",
    "GetFailure": "500",
    "PatchSuccess": "200",
    "PatchFailure": "500",
    "PutSuccess": "200",
    "PutFailure": "500",
    "DeleteSuccess": "200",
    "DeleteFailure": "500",
    "EnableWebLegacy": "false",
    "EnableStaticFiles": "true",
    "ShowHttpRequests": "true",
    "ShowBadRequestDetails": "false"
  },
General
enable Enable Adapter Web (True/False)
url Sets the public urls for web/API exposure
enableswagger Activate Swagger
PostSuccess Default Code Definition for HTTP Error in API
PostFailure Default Code Definition for HTTP Error in API
GetSuccess Default Code Definition for HTTP Error in API
GetFailure Default Code Definition for HTTP Error in API
PatchSuccess Default Code Definition for HTTP Error in API
PutSuccess Default Code Definition for HTTP Error in API
DeleteSuccess Default Code Definition for HTTP Error in API
DeleteFailure Default Code Definition for HTTP Error in API
EnableWebLegacy Enables support for legacy ASP.NET Controllers (True/False)
ShowHttpRequests Enables verbosity of incoming requests (True/False)
ShowBadRequestDetails Enables verbose return in the API of malformed requests with automatic error 400 (True/False)
Last modified August 20, 2024 (2f9802da)