Página Inicial>Relacionado com a programação>Outro código-fonte
Baixar

API Dorar.net Hadith

Que a paz, as bênçãos e a misericórdia de Deus estejam com você

Há algum tempo tentei usar a API dental pearls
Mas enfrentei algumas dificuldades, inclusive que a API só lida com JSONP, e você não conseguirá lidar com isso de maneira normal por causa do CORS.

Se você conseguir evitar CORS usando JSONP obterá a saída em formato HTML . Além disso, não há documentation ou documento explicando os detalhes desta API e como lidar com ela.

Decidi criar uma API intermediária que evita o problema CORS e fornece os dados no formato JSON junto com uma explicação detalhada da API e como usá-la
Além de conter alguns recursos adicionais que não são encontrados na API oficial

alerta

  • Cada pesquisa é cache por 5 segundos
  • Existe um limite de uso: 100 pesquisas por dia por IP

Você pode editá-los no arquivo config.js

Execute a API

  1. fork ou clone este projeto
  2. Instalar dependencies 
npm install
  1. Verifique o arquivo config.js e modifique o que quiser
  2. Execute a API 
npm start
  1. A API estará disponível no seguinte link 
http://localhost:5000
  1. Use-o no localhost como desejar ou carregue-o em sua própria hospedagem ou servidor

Documentação

Carteiro

Link: Carteiro

  • Use Postman para aprender como trabalhar com a API e ver exemplos
  • fork a collection para usá-la como desejar
  • Não se esqueça de alterar o environment para dev e você pode alterar o link da variável {{url}} caso tenha alterado ou alterado a port

OpenAPI v3 (Swagger)

Documentação da API

Para visualizar a documentação interativa da API:

  1. Execute o servidor: 

     npm run dev

  2. Abra seu navegador e acesse: 

     http://localhost:5000/api-docs

Aqui você encontrará a UI do Swagger que permite explorar todos os endpoints disponíveis e testar a API diretamente do navegador.

Pontos finais

A API contém um conjunto de endpoint

  • Quando o endpoint começa com /api , ele pesquisa na API oficial do Durar Al-Suniya
  • Quando o endpoint começa com /site , é assim que ele é pesquisado na página de pesquisa do Durar Al-Sunniyya

/v1/api/hadith/search?value={texto}

Pesquisar hadiths dá 15 resultados

Formate a resposta como JSON 

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "book" : " الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة "
    }
  ]
}

/v1/site/hadith/search?value={texto}

Pesquisar hadiths dá 30 resultados

Formate a resposta como JSON 

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "numberOfNonSpecialist" : " عدد الأحاديث لغير المتخصصين " ,
    "numberOfSpecialist" : " عدد الأحاديث للمتخصصين " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "mohdithId" : " رقم المحدث " ,
      "book" : " الكتاب " ,
      "bookId" : " رقم الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "explainGrade" : " توضيح درجة الصحة " ,
      "takhrij" : " تخريج الحديث في كتب أخرى " ,
      "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
      "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
      "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
      "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
      "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
      "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
      "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
      }
    }
  ]
}

/v1/site/hadith/similar/:id

Traz para você conversas semelhantes correspondentes ao id

Formate a resposta como JSON 

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "mohdithId" : " رقم المحدث " ,
      "book" : " الكتاب " ,
      "bookId" : " رقم الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "explainGrade" : " توضيح درجة الصحة " ,
      "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
      "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
      "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
      "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
      "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
      "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
      "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
      }
    }
  ]
}

/v1/site/hadith/:id

Traz para você a conversa correspondente ao id

Formate a resposta como JSON 

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "book" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "explainGrade" : " توضيح درجة الصحة " ,
    "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
    "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
    "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
    "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
    "alternateHadithSahihDorar" : " رابط الحديث الصحيح في موقع الدرر " ,
    "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
    "urlToGetAlternateHadithSahih" : " رابط لكي تبحث عن الحديث الصحيح " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
    }
  }
}

/v1/site/hadith/alternate/:id

Ele traz para você o hadith correto correspondente ao id

Formate a resposta como JSON 

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "book" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "hadithId" : " رقم الحديث لاستخدامه في البحث عن الأحاديث البديلة أو الحديث البديل الصحيح " ,
    "hasSimilarHadith" : " هل الحديث له أحاديث مشابهة أم لا " ,
    "hasAlternateHadithSahih" : " هل الحديث له حديث صحيح بديل أم لا " ,
    "similarHadithDorar" : " رابط الأحاديث المشابهة في موقع الدرر " ,
    "urlToGetSimilarHadith" : " رابط لكي تبحث عن الأحاديث المشابهة " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث "
    }
  }
}

/v1/site/compartilhar/:id

Para procurar uma explicação de um único hadith usando id

Formate a resposta como JSON 

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "book" : " الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "takhrij" : " تخريج الحديث في كتب أخرى " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
      "sharh" : " شرح الحديث "
    }
  }
}

/v1/site/share/text/:texto

Para procurar uma explicação de um hadith com base no método do texto fornecido

Formate a resposta como JSON 

{
  "metadata" : {
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "hadith" : " الحديث " ,
    "rawi" : " الراوي " ,
    "mohdith" : " المحدث " ,
    "book" : " الكتاب " ,
    "numberOrPage" : " رقم الحديث او الصفحة " ,
    "grade" : " درجة الصحة " ,
    "takhrij" : " تخريج الحديث في كتب أخرى " ,
    "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
    "sharhMetadata" : {
      "id" : " رقم الشرح " ,
      "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
      "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
      "sharh" : " شرح الحديث "
    }
  }
}

/v1/site/share/search?value={texto}

Procurar uma explicação dos hadiths dá 30 resultados

Formate a resposta como JSON 

{
  "metadata" : {
    "length" : " عدد نتائج البحث " ,
    "page" : " رقم الصفحة " ,
    "removeHTML" : " هل عناصر الـ HTML ممسوحة أم لا " ,
    "specialist" : " نوع الاحاديث هل هي للمتخصصين أم لا " ,
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : [
    {
      "hadith" : " الحديث " ,
      "rawi" : " الراوي " ,
      "mohdith" : " المحدث " ,
      "book" : " الكتاب " ,
      "numberOrPage" : " رقم الحديث او الصفحة " ,
      "grade" : " درجة الصحة " ,
      "takhrij" : " تخريج الحديث في كتب أخرى " ,
      "hasSharhMetadata" : " هل الحديث له شرح أم لا " ,
      "sharhMetadata" : {
        "id" : " رقم الشرح " ,
        "isContainSharh" : " هل يحتوى هذا الرد على شرح الحديث أم لا؟ " ,
        "urlToGetSharh" : " رابط لكي تبحث عن شرح الحديث " ,
        "sharh" : " شرح الحديث "
      }
    }
  ]
}

/v1/site/mohdith/:id

Para pesquisar informações sobre o palestrante usando o id

Formate a resposta como JSON 

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "name" : " المحدث " ,
    "mohdithId" : " رقم المحدث " ,
    "info" : " معلومات عن المحدث "
  }
}

/v1/site/livro/:id

Para pesquisar informações sobre o livro usando o id

Formate a resposta como JSON 

{
  "metadata" : {
    "isCached" : " هل هذه النتائج من الـ cache أم لا "
  },
  "data" : {
    "name" : " الكتاب " ,
    "bookId" : " رقم الكتاب " ,
    "author" : " المؤلف " ,
    "reviewer" : " المراجع " ,
    "publisher" : " دار النشر " ,
    "edition" : " رقم الطبعة " ,
    "editionYear" : " سنة الطبعة "
  }
}

Consulta

Elementos query que você pode usar
Com uma explicação detalhada abaixo da tabela

chave. Descrição
value É o conteúdo do texto do hadith que você deseja pesquisar
page Para selecionar a página desejada
removehtml Excluir elementos HTML na fala
specialist É usado para determinar o tipo de hadith, sejam eles para especialistas ou não
xclude Uma palavra ou frase que você deseja excluir da pesquisa
st Determine o método de pesquisa
t Defina o escopo da pesquisa
d[] Determine o grau do hadith, se é autêntico ou fraco
m[] Especifique os nomes das atualizações que você deseja
s[] Selecione os livros que deseja pesquisar
rawi[] Especifique os nomes dos narradores que você deseja
  • Esses colchetes [] indicam que este elemento aceita mais de uma opção

valor.

  • O conteúdo do texto hadith que você deseja pesquisar
  • Exemplo: /v1/api/hadith/search?value=جملة البحث
    Isso pesquisará com base no termo de pesquisa

página

  • Para selecionar a página desejada
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&page=1
    Isso pesquisará nos resultados da pesquisa a terceira página, ou seja, o terceiro grupo de resultados da pesquisa
  • O valor padrão será página um page=1

removerhtml

  • Excluir elementos HTML na fala
    Como <span class="search-keys">...</span>
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&removehtml=true
    Isso excluirá os elementos HTML dos resultados da pesquisa
  • O valor padrão é true

especialista

  • É usado para determinar o tipo de hadith, sejam eles para especialistas ou não
  • Seus valores são true para especialistas e false para não especialistas
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&specialist=true
    Isso lhe proporcionará mais e diferentes conversas, especialmente para especialistas
    Ele contém informações adicionais, como classificação de hadiths em outros livros
  • O valor padrão é false

xcluir

  • Exemplo: uma palavra ou frase que você deseja excluir da pesquisa
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&xclude=اليهود
    Assim, a palavra اليهود será excluída da pesquisa

st

  • O método de pesquisa é limitado a apenas três opções
  • Esses métodos são: جميع الكلمات , أي كلمة , بحث مطابق
  • Seus valores são: w , a , p
    Para pesquisar por جميع الكلمات st=w
    Para pesquisar أي كلمة será st=a
    Para pesquisar com بحث مطابق st=p
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&st=p
    Assim, ele pesquisará de forma idêntica ao termo de pesquisa

Todos os valores e métodos de pesquisa que representam
Ou você pode obtê-lo como um arquivo JSON aqui

t

  • Defina o escopo da pesquisa
  • Essas faixas são: جميع الأحاديث , الأحاديث المرفوعة , الأحاديث القدسية , آثار الصحابة , شروح الأحاديث
  • Seus valores são: * , 0 , 1 , 2 , 3
    Para pesquisar جميع الأحاديث será t=*
    Para procurar الأحاديث المرفوعة , t=0
    Para procurar الأحاديث القدسية t=1
    Para procurar آثار الصحابة t=2
    Para procurar شروح الأحاديث , t=3
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&t=1
    Assim, ele procurará apenas os hadiths sagrados que correspondam ao termo de pesquisa

Todos os valores e os intervalos de pesquisa que eles representam
Ou você pode obtê-lo como um arquivo JSON aqui

e[]

  • Determine o grau do hadith, se é autêntico ou fraco
  • Seus valores são: 0 , 1 , 2 , 3 , 4
    Para pesquisar جميع الدرجات d[]=0
    Para procurar أحاديث حكم المحدثون عليها بالصحة será d[]=1
    Para procurar أحاديث حكم المحدثون على أسانيدها بالصحة será d[]=2
    Para procurar أحاديث حكم المحدثون عليها بالضعف será d[]=3
    Para procurar أحاديث حكم المحدثون على أسانيدها بالضعف será d[]=4
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&d[]=3
    Assim, ele só procurará hadiths que estão condenados a serem fracos
  • Você pode selecionar mais de uma opção
    Exemplo: /v1/api/hadith/search?value=جملة البحث&d[]=1&d[]=2
    Assim, ele só procurará hadiths que sejam considerados autênticos em termos de texto e cadeia de transmissão.

Todos os valores e graus que eles representam
Ou você pode obtê-lo como um arquivo JSON aqui

eu[]

  • Especifique os nomes das atualizações que você deseja
  • Possui vários valores, incluindo: 0 , 179 , 204 , 256 , 261 ...etc.
    Onde 0 representa جميع المحدثين
    E 179 representa الإمام المالك
    E 204 representa الإمام الشافعي
    E 256 representa البخاري
    E 261 representa مسلم
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&m[]=179
    Assim, ele procurará apenas os hadiths que foram narrados pelo Imam Malik
  • Você pode selecionar mais de uma opção
    Exemplo: /v1/api/hadith/search?value=جملة البحث&m[]=256&m[]=261
    Assim, ele procurará apenas os hadiths narrados por Bukhari e Muslim

Todos os valores e os nomes dos falantes que eles representam
Ou você pode obtê-lo como um arquivo JSON aqui

e[]

  • Selecione os livros que deseja pesquisar
  • Possui vários valores, incluindo: 0 , 13457 , 6216 , 3088 , 96 ...etc.
    Onde 0 representa جميع المحدثين e 13457 representa الأربعون النووية
    E 6216 representa صحيح البخاري
    E 3088 representa صحيح مسلم
    E 96 representa الصحيح المسند
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&s[]=96
    Assim, ele buscará apenas os hadiths contidos no livro Al-Sahih Al-Musnad
  • Você pode selecionar mais de uma opção
    Exemplo: /v1/api/hadith/search?value=جملة البحث&s[]=6216&s[]=13457
    Assim, ele procurará apenas os hadiths que foram mencionados em meu livro, The Forty Nawawi e no livro Sahih Al-Bukhari

Todos os valores e nomes dos livros que representam
Ou você pode obtê-lo como um arquivo JSON aqui

cru[]

  • Especifique os nomes dos narradores que você deseja
  • Possui vários valores, incluindo: 0 , 1819 , 8918 , 2664 ...etc.
    Onde 0 representa جميع الرواة
    Onde 1819 representa أسماء بنت أبي بكر
    E 8918 representa عمر بن الخطاب
    E 2664 representa ابن عباس
  • Exemplo: /v1/api/hadith/search?value=جملة البحث&rawi[]=1819
    Assim, ele procurará apenas os hadiths narrados por Asmaa bint Abi Bakr
  • Você pode selecionar mais de uma opção
    Exemplo: /v1/api/hadith/search?value=جملة البحث&rawi[]=8918&rawi[]=2664
    Assim, ele procurará apenas os hadiths narrados por Omar bin Al-Khattab e Ibn Abbas
  • Aqui estão valores que simbolizam mais de uma pessoa ao mesmo tempo
    Tal como 2665 simboliza ابن عباس أو أبو هريرة
    E 8924 simboliza عمر بن الخطاب وأبو هريرة
    E 264 simboliza أبو الدرداء وأبو أمامة وعبدالله بن عمر وابن عباس وجابر بن عبدالله

Todos os valores e os nomes dos narradores que os representam
Ou você pode obtê-lo como um arquivo JSON aqui

Dados

Todos os dados disponíveis e os valores que eles representam podem ser obtidos nesses endpoints 

[
  {
    "endpoint" : " /v1/data/book " ,
    "description" : " احضار كل الكتب المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/degree " ,
    "description" : " احضار كل درجات الحديث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/methodSearch " ,
    "description" : " احضار كل طرق البحث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/mohdith " ,
    "description" : " احضار كل المحدثين المتاحين " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/rawi " ,
    "description" : " احضار كل الرواة المتاحين " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  },
  {
    "endpoint" : " /v1/data/zoneSearch " ,
    "description" : " احضار كل نطاقات البحث المتاحة " ,
    "abstractResponse" : [
      {
        "key" : " الكلمة  المفتاحية " ,
        "value" : " القيمة "
      }
    ]
  }
]

Há algum problema ou você tem alguma sugestão?

Abra um problema se você encontrar um problema ou tiver uma sugestão

Contribuição

É claro que agradecemos qualquer uma de nossas contribuições ❤

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos