Web

The web session gathers configurations, such as exposed endpoints, Swagger enablement, standard HTTP error codes, viewing HTTP request details, and handling 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 API’s. If you want, 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 Web Adapter (True/False)
url Defines public urls for Web/API exposure
enableswagger Activates 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 compatibility with legacy ASP.NET Controllers (True/False)
ShowHttpRequests Enables breakdown of incoming requests (True/False)
ShowBadRequestDetails Enables verbose return in the API of malformed requests with automatic error 400 (True/False)
Last modified January 10, 2024 (967dcac3)