You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/12/23 08:01:13 UTC

[GitHub] [apisix] boekkooi-lengoo commented on issue #7987: help request: customize the return description and error page

boekkooi-lengoo commented on issue #7987:
URL: https://github.com/apache/apisix/issues/7987#issuecomment-1363711257

   Hey all, 
   So I hit the same issue where a 401 was returned by the `openid` plugin and it shows the nginx/openresty [error page](https://github.com/api7/apisix-nginx-module/blob/main/patch/1.21.4/nginx-error_page_contains_apisix.patch).
   
   To be it feels very inconsistent that some plugins return error like `{"error_msg": "...."}` and then at other moment you need to deal with nginx error pages. 
   
   Any how in my case I used the following code to match the error message up.
   
   ```YAML
     configurationSnippet:
       # Based on
       # - https://blog.adriaan.io/one-nginx-error-page-to-rule-them-all.html
       # - https://gist.github.com/lextoumbourou/d6221deb818da4f342ea
       httpStart: |
         more_clear_headers Server;
         
         map $status $status_text {
           400 'Bad Request';
           401 'Unauthorized';
           402 'Payment Required';
           403 'Forbidden';
           404 'Not Found';
           405 'Method Not Allowed';
           406 'Not Acceptable';
           407 'Proxy Authentication Required';
           408 'Request Timeout';
           409 'Conflict';
           410 'Gone';
           411 'Length Required';
           412 'Precondition Failed';
           413 'Payload Too Large';
           414 'URI Too Long';
           415 'Unsupported Media Type';
           416 'Range Not Satisfiable';
           417 'Expectation Failed';
           418 'I\'m a teapot';
           421 'Misdirected Request';
           422 'Unprocessable Entity';
           423 'Locked';
           424 'Failed Dependency';
           425 'Too Early';
           426 'Upgrade Required';
           428 'Precondition Required';
           429 'Too Many Requests';
           431 'Request Header Fields Too Large';
           451 'Unavailable For Legal Reasons';
           500 'Internal Server Error';
           501 'Not Implemented';
           502 'Bad Gateway';
           503 'Service Unavailable';
           504 'Gateway Timeout';
           505 'HTTP Version Not Supported';
           506 'Variant Also Negotiates';
           507 'Insufficient Storage';
           508 'Loop Detected';
           510 'Not Extended';
           511 'Network Authentication Required';
           default 'Something is wrong';
         }
         map $http_accept $extension {
           default html;
           ~*application/json json;
         }
       httpSrv: |
         error_page 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 421 422 423 424 425 426 428 429 431 451 500 501 502 503 504 505 506 507 508 510 511 @error_$extension;
   
         location @error_json {
           types { } default_type "application/json; charset=utf-8";
           echo '{"error_msg": "$status_text"}';
         }
         location @error_html {
           types { } default_type "text/html; charset=utf-8";
           echo '<html><head><title>$status $status_text</title></head><body><center><h1>$status $status_text</h1></center></html>';
         }
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org