OpenAPI

API ya Biblia ya Matumizi ya Bure huchapisha hati ya OpenAPI 3.1 inayoelezea kila sehemu ya mwisho katika marejeleo haya, pamoja na vigezo vyake na miundo ya majibu.

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

Unaweza kutumia hati hii kwa:

• Tengeneza maktaba ya mteja kwa lugha ambayo hatuna SDK yake.
• Ingiza API kwenye zana kama vile Postman , Insomnia , au Swagger UI ili kuchunguza sehemu za mwisho.
• Thibitisha majibu ya API dhidi ya mipango iliyochapishwa.

Kutengeneza Mteja

Jenereta yoyote ya msimbo inayooana na OpenAPI inaweza kutumika kutengeneza mteja. Kwa mfano, Jenereta ya OpenAPI inasaidia lugha nyingi :

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

Kwa TypeScript, unaweza kutumia @hey-api/openapi-ts :

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

Operesheni

Kila sehemu ya mwisho katika hati ya OpenAPI ina operationId , ambayo jenereta nyingi hutumia kama jina la mbinu katika mteja aliyezalishwa. Kwa mfano:

Tazama hati ya OpenAPI kwa orodha kamili ya shughuli.