azure-rest-api-specs - MicrosoftAzureのRESTAPI仕様のソース。

(The source for REST API specifications for Microsoft Azure.)

Created at: 2015-07-15 02:37:13
Language: TypeScript
License: MIT

AzureRESTAPIの仕様

説明

このリポジトリは、MicrosoftAzureのRESTAPI仕様の正規のソースです。

入門

パイプラインのすべてのリポジトリとステップに関する情報を探しているMicrosoftの従業員の場合は、AzureSDK-InternalWikiにアクセスしてください。必ずGithubAzure組織に参加して、そのwikiリポジトリにアクセスしてください。アクセスに問題がある場合は、このフォームを使用してサポートリクエストを送信してください。

最新の改善点:マイクロソフトの従業員は、 OpenAPI Hubでの新しいエクスペリエンスを試すことができます。これは、検証ツールを使用してワークフローを見つけるためのオンラインエクスペリエンスです。

外部の貢献者はここから始めることができます

前回の訪問以降の新しい更新については、お知らせページを確認してください。

ディレクトリ構造

ディレクトリの構造は、次の規則に厳密に従う必要があります。

  1. プロファイル:プロファイルホルダーには、プロファイルの定義MDファイルが含まれています。これらのファイルには、特定のプロファイルを表すRPのリソースタイプまたはDataplaneAPIバージョンのスナップショットへの情報と参照が含まれます。

  2. 仕様:このフォルダーは、すべての仕様(管理およびデータプレーン)関連のドキュメントのルートフォルダーです。

  3. {RP-Name}フォルダ-各RPには個別のフォルダがあります

  4. 'resource-manager'および'data-plane'フォルダー:RPは、

    resource-manager
    (ARMリソースの場合)および
    data-plane
    (その他すべての場合)の2つのカテゴリーのいずれかに仕様を入れることができます。RPのautorest構成ファイル(
    readme.md
    )は、このフォルダー内にある必要があります

  5. 'preview'および'stable'フォルダー:さまざまなレベルの安定性がリポジトリに存在します。各APIバージョンフォルダーは、重大な変更を引き続き受け入れるか、重大な変更を受け入れないかのいずれかに分類する必要があります。これは、APIバージョンに「-preview」サフィックスが付いているかどうかを直接表すものではありません。'preview'フォルダーアイテムから生成されたSDKは、重大な変更がまだ行われている可能性があることを最も慣用的な方法で顧客に示す必要があります。

  6. APIバージョン:このフォルダーは、カテゴリーフォルダーの直接の子になります。リソースタイプまたはデータプレーンサービスバージョンごとにそのようなフォルダが1つあります。このフォルダーには、OpenAPI検証仕様(以前はSwaggers)とexamplesフォルダーが含まれます。

  7. :exampleフォルダーにはx-ms-examplesファイルが含まれます。APIまたはリソースタイプのバージョンが異なると例が異なる可能性があるため、APIまたはリソースのバージョンフォルダの下に存在します。

    • フォルダ名は単数である必要があります(つまり、「profiles」ではなく「profile」)。これにより、英語を話さない一部の話者のあいまいさがなくなります。
    • 一般的なフォルダ名は小文字にする必要があります
    • 固有名/製品名/名前空間フォルダーはPascalCased(つまり、「KeyVault」)にすることができます
    • ファイルは、あなたが自分の魂に良いと思うどんな場合でもあります。

構造は次のようになります。

.
\---specification
|    +---automation
|    |   \---resource-manager
|    |       \---Microsoft.Automation
|    |           \---stable
|    |               \---2015-10-31
|    |                   \---examples
|    +---batch
|    |   +---data-plane
|    |   |   \---Microsoft.Batch
|    |   |       +---stable
|    |   |       |   +---2015-12-01.2.2
|    |   |       |   +---2016-02-01.3.0
|    |   |       |   +---2016-07-01.3.1
|    |   |       |   +---2017-01-01.4.0
|    |   |       |       \---examples
|    |   |       \---preview
|    |   |           \---2017-05-01.5.0
|    |   \---resource-manager
|    |       \---Microsoft.Batch
|    |           +---stable
|    |           |   +---2015-12-01
|    |           |   +---2017-01-01
|    |           |       \---examples
|    |           \---2017-05-01
|    |               \---examples
|    +---billing
|        \---resource-manager
|            \---Microsoft.Billing
|                \---stable
|                |   +---2017-02-27-preview
|                |       \---examples
|                +---preview
|                    \---2017-04-24-preview
|                        \---examples
\--- readme.md

現在、仕様はSwaggerJSON形式であると予想されます

次のステップ

仕様が完成した後のプロセスの次のステップは、SDKとAPIリファレンスドキュメントを生成することです。Microsoftの従業員の場合、詳細については、AzureSDK-InternalWikiにアクセスしてください。


このプロジェクトは、Microsoftオープンソース行動規範を採用しています。詳細については、行動規範に関するFAQを参照するか、 [email protected]に質問やコメントをお問い合わせください。