Scalar

Scalarは、プロフェッショナルな見た目でスムーズに動作するAPIドキュメント作成プラットフォームです。OpenAPIドキュメントを提供すると、Scalarが例やテストツールを組み込んだ読みやすいページに変換します。

このプラットフォームは複数の製品が連携して動作します。APIリファレンスはドキュメントをシンプルなレイアウトで表示します。APIクライアントは開発者がエンドポイントを直接テストできる機能を提供します。また、複数バージョンのAPIドキュメント管理やGitHubとの同期ツールも含まれています。

Scalarは完全にオープンソースであり、コードは公開されていて無料で利用可能です。自分でホスティングすることも、クラウドサービスを利用することもできます。無料プランは基本機能をカバーし、有料プランではコラボレーションツール、カスタムドメイン、より充実したサポートが追加されます。

Scalarの使用は簡単で、複雑な設定は必要ありません。始めるための手順は以下の通りです：

• Scalarのウェブサイトにアクセスし、無料アカウントを作成して作業を保存します。yourname.apidocumentation.comのような無料のサブドメインが取得できます。

• URLを貼り付ける、ファイルをアップロードする、またはGitHubに接続してOpenAPIドキュメントをアップロードします。ScalarはJSONとYAMLの両形式に対応しています。

• テーマを選び、ブランドに合わせて色をカスタマイズします。デザインをより細かく調整したい場合はカスタムCSSを追加できます。

• エディターを使って追加のガイドを書きます。これらのページは自動生成されたリファレンスページを超えた概念を説明します。

• 組み込みのクライアントを使ってAPIエンドポイントをテストします。任意のエンドポイントをクリックし、パラメータを追加してリクエストを送信し、実際のレスポンスを確認できます。

• ドキュメントをチームと共有するか、公開します。編集や閲覧の権限を設定して管理できます。

• OpenAPIファイルから美しいAPIドキュメントを作成

• APIクライアントによる組み込みテスト機能

• GitHub連携と自動同期

• カスタムドメインとテーマ

• 主要プラットフォーム向けフレームワーク統合

• TypeSense搭載の検索機能

• 複数APIバージョンのサポート

• MarkdownおよびMDXガイド

• チームコラボレーションツール

• オープンソースでセルフホスティング可能

• 無料サブドメイン付き

• カスタムCSSおよびJavaScript対応