製品

API 設計

APIGit は、業界で REST API を定義するための標準として、広く受け入れられサポートされている OpenAPI 仕様 3.0.x を利用しています。当社が開発した、使いやすく、完全に視覚化された OpenAPI エディターを使用すると、OpenAPI 仕様の予備知識がなくても、API 仕様をすばやく簡単に作成できます。視覚的なインターフェイスにより、誰でも簡単に理解して API ドキュメントを作成できるため、開発プロセスが合理化され、業界標準に準拠した高品質の API の作成に専念できます。

API 仕様表示モード - デフォルト
表示モードでは、視覚的に美しいデザイン テーマで API ドキュメントを表示できます。さらに、好みに応じてオリジナルのスワッガー テーマに切り替えるオプションもあります。 API 仕様は、公開された時点で同じように見えます。 「編集」ボタンをクリックすると、API 編集モードに入ることができます。
API 仕様ビュー モード - swagger-ui ビュー
swagger ビュー モードでは、swagger テーマで API 仕様を表示できるため、標準形式の API ドキュメントを簡単に理解して操作できます。
API 仕様ビュー モード - コード ビュー
コード モードでは、未加工のプレーンな API 仕様のコンテンツが表示され、基になるコードを直接見ることができます。
API 仕様ビュー モード - 差分ビュー
差分表示モードでは、ある API 仕様を別の仕様と比較して、それらの違いを簡単に識別できます。

API 仕様編集モード - フォーム ビュー
[編集] ボタンをクリックすると、API 仕様がフォーム編集モードになり、API を変更する最も簡単な方法になります。このモードでは、仕様が完全に視覚化されているため、OpenAPI の知識は必要なく、理解と編集が容易になります。
API 仕様編集モード - コード ビュー
コード モードでは、未加工の API ドキュメント コンテンツを表示できるため、直接編集したり、仕様の問題をトラブルシューティングしたりできます。
API 仕様編集モード - 差分ビュー
差分モードでは、編集中の API 仕様の現在のバージョンを元のバージョンと比較し、コンテンツを直接編集できます。これにより、2 つのバージョン間の違いを簡単に特定して解決し、変更が正確で元のバージョンと一致していることを確認できます。

API 仕様の作成またはアップロード
私たちのプラットフォームは、空の API 仕様を作成するか、既存のものをリポジトリにアップロードする機能を提供します。さらに、HAR ファイルをアップロードするオプションをサポートしています。これにより、自動的に API 仕様に変換されます。