Skip to content

GET /api/faq/category/:id

Publiczny endpoint wyszukiwania wpisow FAQ w konkretnej kategorii.

Bazowy URL

  • Produkcja: https://faq.dlapolakow.app

Request

  • Metoda: GET
  • Sciezka: /api/faq/category/:id

Path params

  • id (number, required): identyfikator kategorii.

Query params

  • q (string, optional): fraza wyszukiwania.
  • lang (string, optional): pl,en,nl. Domyslnie pl.

Przyklad request

bash
curl -X GET "https://faq.dlapolakow.app/api/faq/category/1?q=podatek&lang=pl"

Response 200

json
{
  "ok": true,
  "category": {
    "id": 1,
    "name": {
      "pl": "Formalnosci",
      "en": "Formalities",
      "nl": "Formaliteiten"
    }
  },
  "faqs": [
    {
      "id": "8b96f5ef2b2f4be8a77d6c6f3a8de9f1",
      "slug": "podatki-w-holandii",
      "seo_title": "Podatki w Holandii",
      "seo_description": "Najwazniejsze informacje podatkowe",
      "category": {
        "id": 1,
        "name": {
          "pl": "Formalnosci",
          "en": "Formalities",
          "nl": "Formaliteiten"
        }
      }
    }
  ],
  "total": 1,
  "q": "podatek"
}

Zachowanie endpointu

  • Zwraca tylko wpisy ze statusem published i z podanej kategorii.
  • Gdy q jest puste, zwraca do 50 wpisow z tej kategorii.
  • Gdy q jest podane, stosuje wyszukiwanie po tych samych polach co glowny endpoint FAQ.

Kody bledow

  • 400 niepoprawne id kategorii:
json
{
  "ok": false,
  "error": "Invalid category id"
}
  • 404 brak kategorii:
json
{
  "ok": false,
  "error": "Category not found"
}
  • 500 blad serwera:
json
{
  "ok": false,
  "error": "Unknown error"
}