Коришћење Голанга за руковање АВС СДК АПИ кодовима грешака за РЕСТ АПИ одговоре

Руковање ХТТП кодовима грешака из АВС СДК захтева у Голангу

Имплементација модуларних Голанг позадинских скрипти за управљање ХТТП грешкама из АВС СДК-а

// Approach 1: Using a Mapping Table to Convert String Error Codes to HTTP Status Codes
package main

import (
    "errors"
    "fmt"
    "net/http"
    "github.com/aws/smithy-go"
)

// UsecaseError represents the custom error structure for JSON responses
type UsecaseError struct {
    Code    int    `json:"code"`
    Message string `json:"message"`
}

// Error satisfies the error interface for UsecaseError
func (e *UsecaseError) Error() string {
    return fmt.Sprintf(`{"code": %d, "message": "%s"}`, e.Code, e.Message)
}

// Map of AWS error codes to HTTP status codes
var errorCodeMapping = map[string]int{
    "NotAuthorizedException": http.StatusUnauthorized,
    "UserNotFoundException": http.StatusNotFound,
    "TooManyRequestsException": http.StatusTooManyRequests,
    "InternalErrorException": http.StatusInternalServerError,
    // Add additional mappings as necessary
}

// ConvertAWSAPIError handles AWS SDK errors and returns a UsecaseError
func ConvertAWSAPIError(err error) *UsecaseError {
    var apiErr smithy.APIError
    if errors.As(err, &apiErr) {
        code, exists := errorCodeMapping[apiErr.ErrorCode()]
        if exists {
            return &UsecaseError{
                Code:    code,
                Message: apiErr.ErrorMessage(),
            }
        }
    }
    // Default error response
    return &UsecaseError{
        Code:    http.StatusInternalServerError,
        Message: "An unknown error occurred",
    }
}

Конвертовање АВС кодова грешака са тврдњама типа у Голангу

Коришћење тврдњи типа за побољшано руковање грешкама у Голангу

package main

import (
    "errors"
    "fmt"
    "net/http"
    "github.com/aws/smithy-go"
)

// UsecaseError struct to hold HTTP code and message
type UsecaseError struct {
    Code    int    `json:"code"`
    Message string `json:"message"`
}

func (e *UsecaseError) Error() string {
    return fmt.Sprintf(`{"code": %d, "message": "%s"}`, e.Code, e.Message)
}

// AWSAPIErrorToHTTP maps APIError codes directly to HTTP status codes using type assertions
func AWSAPIErrorToHTTP(err error) *UsecaseError {
    var apiErr smithy.APIError
    if errors.As(err, &apiErr) {
        switch apiErr.ErrorCode() {
        case "NotAuthorizedException":
            return &UsecaseError{Code: http.StatusUnauthorized, Message: apiErr.ErrorMessage()}
        case "UserNotFoundException":
            return &UsecaseError{Code: http.StatusNotFound, Message: apiErr.ErrorMessage()}
        case "TooManyRequestsException":
            return &UsecaseError{Code: http.StatusTooManyRequests, Message: apiErr.ErrorMessage()}
        default:
            return &UsecaseError{Code: http.StatusInternalServerError, Message: apiErr.ErrorMessage()}
        }
    }
    return &UsecaseError{Code: http.StatusInternalServerError, Message: "Unknown error"}
}

Јединични тестови за функције конверзије грешака АВС АПИ-ја

Функције тестирања за валидацију одговора ХТТП статусног кода за различите грешке АВС АПИ-ја

package main

import (
    "errors"
    "testing"
    "net/http"
)

// Mock error types for testing
type mockAPIError struct{}

func (e *mockAPIError) ErrorCode() string {
    return "UserNotFoundException"
}

func (e *mockAPIError) ErrorMessage() string {
    return "User not found"
}

func TestConvertAWSAPIError(t *testing.T) {
    mockErr := &mockAPIError{}
    err := ConvertAWSAPIError(mockErr)
    if err.Code != http.StatusNotFound {
        t.Errorf("expected %d, got %d", http.StatusNotFound, err.Code)
    }
}

Уобичајена питања о АВС СДК руковању грешкама у Голангу

1. Како могу да преузмем ХТТП статусне кодове из АВС СДК грешака?
2. У Голангу, АВС СДК грешке се често враћају као стрингови. Коришћењем прилагођеног мапирања или наредбе свитцх, можете да ускладите кодове грешака са релевантним ХТТП кодовима статуса.
3. Користи switch наводи најбољи приступ за АВС кодове грешака?
4. Док можете да користите а switch Изјава, креирање табеле мапирања је генерално ефикасније и одрживије, посебно како се број кодова грешака повећава.
5. Шта је сврха errors.As у руковању АВС грешкама?
6. Тхе errors.As функција вам омогућава да проверите да ли је грешка одређеног типа, као нпр smithy.APIError. Ово је неопходно за прецизно идентификовање АВС грешака у Голангу.
7. Зашто користити прилагођену структуру грешке попут UsecaseError?
8. Прилагођена структура грешке вам омогућава да форматирате одговоре на грешке на ЈСОН-пријатан начин, што олакшава клијентским апликацијама да рашчлане и разумеју грешке.
9. Како могу ефикасно тестирати АВС СДК код за руковање грешкама?
10. Коришћење лажних грешака у јединичним тестовима омогућава вам да симулирате грешке АВС СДК-а без директног позивања АВС-а, помажући да се потврди како ваш код реагује на сваки тип грешке.
11. Који пакет обезбеђује ХТТП статусне константе у Голангу?
12. Тхе net/http пакет у Голанг-у нуди константе за ХТТП статусне кодове, што олакшава додељивање јасних, стандардних одговора АПИ клијентима.
13. Да ли је могуће ухватити све АВС грешке помоћу једне функције?
14. Да, коришћењем комбинације од errors.As и табелом или прекидачем за мапирање, можете ефикасно да ухватите и обрађујете различите АВС СДК грешке на јединствен начин.
15. Може ли табела мапирања успорити моју апликацију?
16. Тражење табеле мапирања је генерално брже од вишеструких иф-елсе или свитцх изјава. То је ефикасан начин за руковање многим кодовима грешака и топло се препоручује за мапирање грешака.
17. Зашто је потребно конвертовати АВС СДК кодове грешака у ХТТП статусне кодове?
18. Мапирање АВС кодова грешака у ХТТП статусе омогућава вашем АПИ-ју да врати стандардне, конзистентне одговоре, што помаже клијентским апликацијама да брзо схвате природу грешке.
19. Како могу да отклоним грешке у АВС СДК-у које се не подударају ни са једним специфичним кодом грешке?
20. За неочекиване грешке, можете вратити подразумевани статус као што је 500 (унутрашња грешка сервера) и евидентирати детаље грешке за каснији преглед користећи slog.Error.

Поједностављена решења за руковање АВС СДК кодовима грешака

Креирање робусног механизма за руковање грешкама за АВС СДК захтеве у Голанг АПИ-ју може уштедети значајно време за отклањање грешака и побољшати искуство програмера. Кроз тврдње о типовима, мапирања грешака и прилагођене структуре грешака, програмери могу ефикасно да трансформишу необрађене одговоре на грешке АВС-а у читљиве ХТТП кодове који се могу применити. Ово подешавање је посебно корисно када радите са грешкама у аутентификацији у АВС Цогнито.

Интеграцијом јединичних тестова са лажним грешкама, руковање грешкама постаје поуздано у различитим сценаријима грешке. Ове технике не само да побољшавају квалитет АПИ-ја, већ и осигуравају да АПИ остаје прилагодљив и одржаван како захтеви расту. Примена ових стратегија одржава АПИ осетљив и спреман за употребу у производњи. 🛠