OpenAPI

Free Use Bible APIは、このリファレンスに記載されているすべてのエンドポイント、およびそのパラメータとレスポンス構造を説明するOpenAPI 3.1ドキュメントを公開しています。

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

この文書は以下の目的で使用できます。

• SDKが提供されていない言語用のクライアントライブラリを生成します。
• APIをPostman 、 Insomnia 、 Swagger UIなどのツールにインポートして、エンドポイントを調べてください。
• APIレスポンスを公開されているスキーマと照合して検証する。

クライアントの生成

OpenAPI互換のコードジェネレーターであればどれでもクライアントの生成に使用できます。例えば、 OpenAPI Generatorは数十種類の言語をサポートしています。

# 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

TypeScript の場合は、 @hey-api/openapi-ts使用できます。

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

業務

OpenAPIドキュメントの各エンドポイントにはoperationIdが割り当てられており、ほとんどのジェネレーターはこれを生成されたクライアントのメソッド名として使用します。例：

操作の完全なリストについては、 OpenAPIドキュメントを参照してください。