API aperta

L'API Free Use Bible pubblica un documento OpenAPI 3.1 che descrive ogni endpoint presente in questo riferimento, insieme ai relativi parametri e alle strutture di risposta.

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

È possibile utilizzare questo documento per:

Genera una libreria client per un linguaggio per il quale non disponiamo di un SDK .
Importa l'API in strumenti come Postman , Insomnia o Swagger UI per esplorare gli endpoint.
Convalidare le risposte API rispetto agli schemi pubblicati.

Generazione di un client

Qualsiasi generatore di codice compatibile con OpenAPI può essere utilizzato per generare un client. Ad esempio, OpenAPI Generator supporta decine di linguaggi :

# Pitone
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

Per TypeScript, puoi usare @hey-api/openapi-ts :

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

Tips

Se utilizzi JavaScript o TypeScript, probabilmente non hai bisogno di generare il tuo client. Dai un'occhiata all'SDK JavaScript/TypeScript .

Operazioni

Ogni endpoint nel documento OpenAPI ha uno operationId , che la maggior parte dei generatori usa come nome del metodo nel client generato. Ad esempio:

ID operazione	Punto finale
`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`

Per l'elenco completo delle operazioni, consultare la documentazione OpenAPI .