OpenAPI
OpenAPI仕様をページに追加し、インタラクティブなブロックでユーザーがページ上でエンドポイントをテストできるようにする
REST API ドキュメントを手作業で作成するのは時間がかかる場合があります。幸いなことに、GitBook は OpenAPI ドキュメントをインポートできるため、API の構造と機能を詳述したドキュメント作成作業を効率化します。
OpenAPI Specification (OAS) は、開発者が REST API をドキュメント化するために使用するフレームワークです。JSON または YAML で記述され、すべてのエンドポイント、パラメータ、スキーマ、および認証方式を概説します。
これらのドキュメントを GitBook にインポートすると、仕様がファイルとして提供される場合でも URL から読み込まれる場合でも、API メソッドを視覚的に表現するインタラクティブでテスト可能な API ブロックに変換されます。
GitBookはをサポートしています Swagger 2.0 または OpenAPI 3.0 準拠ファイル。
Add a new pet to the store.
10doggiepet status in the store
Successful operation
Invalid input
Validation exception
Unexpected error
POST /api/v3/pet HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"text"
],
"tags": [
{
"id": 1,
"name": "text"
}
],
"status": "available"
}{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"text"
],
"tags": [
{
"id": 1,
"name": "text"
}
],
"status": "available"
}テストする（Scalar による提供）
GitBook の OpenAPI ブロックは「テストする」機能もサポートしており、エディタから入力されたデータとパラメータを使ってユーザーが API メソッドをテストできるようにします。
提供： Scalar、ドキュメントを離れることなく API メソッドの動作を確認できます。上の例を参照してください。
よくある質問
最終更新
役に立ちましたか？