line-openapi
OpenAPI spec of the LINE's Public APIs
LINEの公開APIをOpenAPIスペック（API仕様書の標準形式）として提供し、Bot開発やサービス連携のためのクライアントコードを自動生成できるようにするプロジェクトです。
・企業：社内システムとLINEを連携させる際に、OpenAPIスペックからAPIクライアントを自動生成でき、開発工数を大幅に短縮できます。 ・スタートアップ：LINE Messaging APIやLIFF APIの仕様を正確に把握でき、Swagger UIでAPIの動作確認を手軽に行えるため、開発スピードが上がります。 ・個人事業主・フリーランス：LINE Bot開発時にAPIの仕様を一覧で確認でき、各エンドポイントの使い方を迷わず把握できます。
Slack APIやDiscord APIなど他のメッセージングプラットフォームのAPI仕様は各社独自の形式で提供されていますが、line-openapiはOpenAPI標準に準拠しているため、既存のツールチェーン（コード生成、ドキュメント生成、テスト）をそのまま活用できます。
LINE OpenAPI
これは何？
LINE公開APIのOpenAPIスペックです。
これらのファイルに関する興味深いユースケースやリクエストがある場合は、Issueを作成してください。
このリポジトリではどのAPIがサポートされていますか？
- このリポジトリは、https://developers.line.biz/en/docs/ に掲載されているAPIのOpenAPIスペックを提供しています。
- このリポジトリは
api.line.me、api-data.line.me、manager.line.biz上のAPIをカバーしています。
プロジェクトファイル
| ファイル | OpenAPIバージョン | APIエンドポイント | 説明 |
|---|---|---|---|
| channel-access-token.yml | 3.0.0 | https://api.line.me/ | チャネルアクセストークンAPI |
| insight.yml | 3.0.0 | https://api.line.me/v2/bot/insight/ | インサイトAPI |
| liff.yml | 3.0.2 | https://api.line.me/liff/ | LIFF API |
| manage-audience.yml | 3.0.0 | https://api.line.me/v2/bot/audienceGroup/, https://api-data.line.me/v2/bot/audienceGroup/ | オーディエンスグループAPI |
| messaging-api.yml | 3.0.0 | https://api.line.me/v2/bot/, https://api-data.line.me/v2/bot/ | Messaging API |
| module.yml | 3.0.0 | https://api.line.me/v2/bot/ | Messaging API |
| module-attach.yml | 3.0.0 | https://manager.line.biz/module/auth/v1/token | Messaging API |
| shop.yml | 3.0.0 | https://api.line.me/shop/ | ミッションスタンプAPI |
| webhook.yml | 3.0.3 | Webhookイベントオブジェクト |
コントリビューション方法
line/line-openapi リポジトリへのコントリビューションにご興味いただきありがとうございます！ このプロジェクトは、開発者が簡単にアクセスして統合できるよう、公開機能をOpenAPIスキーマとして公開するものです。 主に社員がAPIの最新機能や変更に基づいてスキーマを更新しています。
以下のガイドラインにご注意ください：
-
プルリクエスト 現在、プルリクエストは社員からのもののみ受け付けています。
-
まずIssueを作成 変更の提案や問題の議論を行う場合は、まずIssueを作成してください。
既知の問題
- OpenAPI GeneratorがJava 17以降でPythonクライアントを生成できない
使い方
Dockerを使用してSwagger UIをローカルで起動し、OpenAPIスペックを閲覧できます。
まず、このディレクトリに docker-compose.yml があることを確認してください。次に以下を実行します：
docker compose up
デフォルトでは、Swagger UIは以下のURLで利用可能です: http://localhost:8080
Dockerコマンドを使用する場合
以下のDockerコマンドでも起動できます：
docker run -p 8080:8080 -e PORT=8080 -e API_URL=/openapi/messaging-api.yml -v $(pwd):/usr/share/nginx/html/openapi swaggerapi/swagger-ui:latest