※ 本記事は、Shyam Suchakによる”Design APIs with OCI Code Editor“を翻訳したものです。
2022年8月18日
新しくリリースされたOracle Cloud Infrastructure（OCI）コード・エディタにより、API開発者はOpenAPI 2.xまたは3.xに記述されたAPI記述のライブ・プレビュー（powered by Redocly）を作成、編集および取得できます。Cloud Editorを使用すると、開発者は残りのコード・プロジェクトとシームレスにAPI仕様を共有してコラボレーションできます。
OCIコード・エディタ
OCIコード・エディタはリッチなコンソール内編集環境を提供し、Oracle Cloud Consoleとローカルの開発環境を切り替えることなく、コードの編集やサービス・ワークフローやスクリプトの更新を行うことができます。コード・エディタは、ファンクションの作成およびデプロイ、リソース・マネージャ・スタックで使用されるTerraform構成の編集、APIの作成および編集など、様々なサービスに対して一般的なコード更新を実行する便利な方法です。
コード・エディタには次の機能があります。
- Java、Python、Docker、JSON、YAML、Terraformなどの15言語でコード・ファイルを作成および編集
- OCIサービスのためのすぐに使用できるマネージド・プラグインにより、シームレスなコード編集エクスペリエンスを実現
- Git統合
- ユーザー・セッション間で状態を保持
- Cloud Shellとその30以上のクラウドベース・ツールへの直接アクセス
- ワークスペースとユーザー管理
- 複数の色テーマ、言語ローカライゼーション、カスタマイズ可能なキーボード・ショートカット、カスタマイズ可能な画面レイアウトなどにより、パーソナライズされたユーザー・エクスペリエンスを実現
コード・エディタを使用してAPIを設計する方法
次のステップを使用して、コード・エディタを使用してAPIを定義します。
- Oracle Cloud Consoleからコード・エディタを起動します。
- API定義には、次の2つのオプションがあります。
「ファイル」メニューに移動して、新規ファイルを最初から作成します。
- API仕様を書き込んで、ホーム・ディレクトリに保存します。または、コード・エディタを閉じて再度開いてファイルの変更を確認することもできます。
- リモートGitリポジトリをクローニングします。F1、⇧⌘PまたはCTRL⇧Pを指定してコマンド・パレットを開き、「Git Clone」と入力して選択し、GitリポジトリのURLを貼り付けます。
コードを編集できます。自動補完と構文の強調表示を確認します。ログアウトしてから再度ログインすると、中断した場所が表示されます。コード・エディタでは、セッション間でファイルの状態が保持されます。
- API仕様をプレビューするには、コマンド・パレットを使用して、「OpenAPI: View」と入力します。
新しいタブが開き、APIの定義から生成されたAPIリファレンス・ドキュメントのプレビューが表示されます。
- APIをデプロイする場合は、コマンドライン・インタフェース（CLI）を使用して新しいAPIデプロイメントを作成します。
API仕様にCloud Shellを使用する方法の詳細は、APIゲートウェイ・ユーザー・ガイドでのAPIのデプロイのCLIの使用に関する項を参照してください。
まとめ
OCI API Gatewayサービスを使用すると、API開発者は独自のAPIをデプロイおよび管理できます。サービスの一部として、API定義ファイルを格納および表示することもできます。OCIコード・エディタを使用すると、API開発者は、コンソールとローカル開発環境を切り替えることなく、Redoc by Redoclyを使用してコード・リポジトリを接続し、APIドキュメントのプレビューを生成できます。
ご意見をお待ちしております。
APIの構築とソフトウェア開発者キットの生成については、次の資料を参照してください。
- クラウド・ネイティブAPI管理の詳細をご覧ください。
- コード・エディタおよびAPIドキュメント・プレビュー・エンジンRedocについての詳細を取得してください。
- APIゲートウェイとその機能については、APIゲートウェイのドキュメントを参照してください。