Free Use Bible API

OpenAPI

Die Free Use Bible API publiseer 'n OpenAPI 3.1- dokument wat elke eindpunt in hierdie verwysing beskryf, tesame met sy parameters en reaksiestrukture.

GET https://bible.helloao.org/openapi.json

Jy kan hierdie dokument gebruik om:

  • Genereer 'n kliëntbiblioteek vir 'n taal waarvoor ons nie 'n SDK het nie.
  • Voer die API in gereedskap soos Postman , Insomnia of Swagger UI in om die eindpunte te verken.
  • Valideer API-antwoorde teen die gepubliseerde skemas.

Genereer 'n kliënt

Enige OpenAPI-versoenbare kodegenerator kan gebruik word om 'n kliënt te genereer. OpenAPI Generator ondersteun byvoorbeeld dosyne tale :

# Python
npx @openapitools/openapi-generator-cli generate \
    -i https://bible.helloao.org/openapi.json \
    -g python \
    -o ./free-use-bible-api-python

# C#
npx @openapitools/openapi-generator-cli generate \
    -i https://bible.helloao.org/openapi.json \
    -g csharp \
    -o ./free-use-bible-api-csharp

Vir TypeScript kan jy @hey-api/openapi-ts gebruik:

npx @hey-api/openapi-ts \
    -i https://bible.helloao.org/openapi.json \
    -o ./src/client

Tips

As jy JavaScript of TypeScript gebruik, hoef jy waarskynlik nie jou eie kliënt te genereer nie. Kyk eerder na die JavaScript/TypeScript SDK .

Bedrywighede

Elke eindpunt in die OpenAPI-dokument het 'n operationId , wat die meeste kragopwekkers as die metodenaam in die gegenereerde kliënt gebruik. Byvoorbeeld:

Operasie-IDEindpunt
getAvailableTranslations/api/available_translations.json
getTranslationBooks/api/{translation}/books.json
getTranslationBookChapter/api/{translation}/{book}/{chapter}.json
getAvailableCommentaries/api/available_commentaries.json
getAvailableDatasets/api/available_datasets.json

Sien die OpenAPI-dokument vir die volledige lys van bewerkings.