sucharygo

README

SucharyPL - oficjalna biblioteka SucharyAPI dla Go

Biblioteka Go do pobierania kawałów z ogólnopolskiej bazy SucharyAPI

---

🚀 Instalacja

Za pomocą go get

go get github.com/SucharyAPI/sucharypl-go

---

⚡ Szybki start

Pobranie losowego suchara

package main

import (
    "fmt"
    "log"

    sucharygo "github.com/SucharyAPI/sucharypl-go"
)

func main() {
    zart, err := sucharygo.DajKawal()
    if err != nil {
        log.Fatalf("Błąd: %v", err)
    }
    fmt.Println(zart)
}

Pobranie suchara z konkretnej kategorii

package main

import (
    "fmt"
    "log"

    sucharygo "github.com/SucharyAPI/sucharypl-go"
)

func main() {
    zart, err := sucharygo.DajKawal(sucharygo.Suchary)
    if err != nil {
        log.Fatalf("Błąd: %v", err)
    }
    fmt.Println(zart)
}

---

Kategorie

• programowanie - Suchary o programowaniu
• dwuznaczne - Suchary dwuznaczne
• szkolne - Suchary szkolne
• suchary - Suchary ogólne
• wulgarne - Suchary wulgarne
• czarnyhumor - Czarny humor
• inne - Inne kategorie

W kodzie dostępne jako typ Kategoria.

---

🛡️ Obsługa błędów

Biblioteka definiuje sformalizowane błędy:

• SucharyError - bazowy błąd
• ConnectionError - problemy z połączeniem
• HTTPError - błędy serwera (z kodem HTTP)
• JSONError - błąd dekodowania odpowiedzi

Przykład obsługi błędów

package main

import (
    "errors"
    "fmt"
    "log"

    sucharygo "github.com/SucharyAPI/sucharypl-go"
)

func main() {
    zart, err := sucharygo.DajKawal(sucharygo.Wulgarne)
    if err != nil {
        var httpErr *sucharygo.HTTPError
        if errors.As(err, &httpErr) {
            fmt.Printf("Błąd HTTP (%d): %s\n", httpErr.Kod, httpErr.Tresc)
            return
        }
        log.Fatalf("Inny błąd: %v", err)
    }
    fmt.Println(zart)
}

---

📡 API

Biblioteka korzysta z oficjalnej bazy SucharyAPI: 🔗 https://sucharyapi.onrender.com

---

📝 Licencja

MIT

---

Documentation

Index

• func DajKawal(kategoria ...Kategoria) (string, error)
• type ConnectionError
  • func (e *ConnectionError) Error() string
• type HTTPError
  • func (e *HTTPError) Error() string
• type JSONError
  • func (e *JSONError) Error() string
• type Kategoria
• type SucharyError
  • func (e *SucharyError) Error() string
• type ZwrotSerwera

Functions

func DajKawal

func DajKawal(kategoria ...Kategoria) (string, error)

Funkcja fetchująca

Types

type ConnectionError

type ConnectionError struct {
	Tresc string
}

func (*ConnectionError) Error

func (e *ConnectionError) Error() string

type HTTPError

type HTTPError struct {
	Kod   int
	Tresc string
}

func (*HTTPError) Error

func (e *HTTPError) Error() string

type JSONError

type JSONError struct {
	Tresc string
}

func (*JSONError) Error

func (e *JSONError) Error() string

type Kategoria

type Kategoria string

Kategorie kawałów

const (
	Domyslna      Kategoria = ""
	Programowanie Kategoria = "programowanie"
	Dwuznaczne    Kategoria = "dwuznaczne"
	Szkolne       Kategoria = "szkolne"
	Suchary       Kategoria = "suchary"
	Wulgarne      Kategoria = "wulgarne"
	CzarnyHumor   Kategoria = "czarnyhumor"
	Inne          Kategoria = "inne"
)

type SucharyError

type SucharyError struct {
	Tresc string
}

Custom errory

func (*SucharyError) Error

func (e *SucharyError) Error() string

type ZwrotSerwera

type ZwrotSerwera struct {
	Zart string `json:"tresc"`
}

Struktura zwrotu z API