読者です 読者をやめる 読者になる 読者になる

Azureの小ネタ (改)

~Azureネタを中心に、色々とその他の技術的なことなどを~

Azure REST API Specifications をパースしてモデル情報を見てみる その2

前回は、Swagger APIのパース部分でつまづいて終わったのですが、続きをやってみました

statemachine.hatenablog.com

Parser

前回記事通り、現状のSwagger製のJava Parserだと、Azure の REST API SPECが正しくパースされないので、結局Java Parserをアドホックに修正して自分の希望通りにパースできるようにしてみました。あまり厳密な解釈にこだわる必要もないので。

Diagram

詳細は後述しますが、ComputeのAPIをモデル化した情報をDiagramエディタにD&Dして、手動レイアウトしたものが以下です。

f:id:StateMachine:20160519131716p:plain

VirtualMachineから関連するオブジェクトが手に取るように分かります。これで内部構造の理解も捗るんじゃないかと思います。

仕組み

前回も少し書きましたが必要な環境は以下です。

  • Eclipse 4.6 Modeling edition
  • Eclipse Modeling Framework(EMF)
  • Swagger Parser
  • API の スキーマ

EclipseにはJava IDEとかとは別に、Modeling Editionがありますので、これを使います。EMFやDiagram Editorなどのプラグインが予め組み込まれています。

やっていることは簡単で、APIをパースするとSwaggerのAPIモデルが作られます。クラスやプロパティ、関連などが機械可読可能な状態になりますので、それをEMFのEcoreモデルでモデリングするだけです。EMFのEcoreモデルはメタモデル(MOF)の実装です。簡単にいってしまえば、Swagger API JSON -> Ecoreモデル(*.ecoreファイル)の変換をしているに過ぎません。

ecoreモデルが出来た後は、Diagram Editorを開いてD&Dしつつ、見える形に整えるだけです。

というわけで、当初も目論見が達成できたので満足です。

Azure REST API Specifications をパースしてモデル情報を見てみる

以前、手書き(UMLツール)で以下を作図したんですが、手書きで書き起こすのはちょっとシンドイです。

statemachine.hatenablog.com

この手の物には、機械可読可能なメタモデル的な定義があるわけでして、それが何かというと以下だったりします。

GitHub - Azure/azure-rest-api-specs: The source for REST API specifications for Microsoft Azure.

これはSwagger のJSONスキーマで定義されているので、パースすれば何らかのモデル情報を読み出せると思ったので試してみました。

当初の目論見では、

  1. JSONをパース
  2. パースした内容をEMF(Eclipseメタモデルフレームワーク)でモデリングするPGを書く。EcoreでもUMLモデルでもどちらでも。
  3. 生成したモデルをGUIエディタにD&DするとDiagramができあがり。

なんてことを夢想しましたが、まだ出来ていません。

パース

Swaggerのツールセットは以下にあります。Swagger謹製のフレームワークもいくつかあります。

Open Source Integrations – Swagger

とりあえず、JavaのSwagger Parserを使ってみます。

github.com

ちなみにAzure ARM APIで使っているAutoRestも列挙されています。

パースはとても簡単で、以下を実行するだけです。リンクを直接読んでくれます。リンク先は、Azure ARM API Computeのスキーマです。

String url = "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/2015-06-15/swagger/compute.json";

SwaggerParser parser = new SwaggerParser();
Swagger swagger = parser.read(url);

swagger.getDefinitions() から定義されたモデル情報が取得できますので、適当にたどって表示させてみましょう。 例えば、VirtualMachinePropertiesというモデルのプロパティを表示させると、以下のようなプロパティ群を持つことが分かります。

** VirtualMachineProperties **
desc  : Describes the properties of a Virtual Machine.
  hardwareProfile      : ref -> #/definitions/HardwareProfile
  storageProfile       : ref -> #/definitions/StorageProfile
  osProfile            : ref -> #/definitions/OSProfile
  networkProfile       : ref -> #/definitions/NetworkProfile
  diagnosticsProfile   : ref -> #/definitions/DiagnosticsProfile
  availabilitySet      : ref -> #/definitions/SubResource
  provisioningState    : string              
  instanceView         : ref -> #/definitions/VirtualMachineInstanceView
  licenseType          : string        

なんか良い感じです。タブン、頂点のVirtualMachineモデルからたどって行けばなんとか行けそうです。

allOf

で、VirtualMachineモデルのパースがうまくいきません。スキーマとして allOfを持っているとこちらが望んだ形でパースされないことがわかりました。スキーマの該当部分は以下です。properitesをパースしてくれない感じでした。

    "VirtualMachine": {
      "properties": {
        "plan": {
          "$ref": "#/definitions/Plan",
          "description": "Gets or sets the purchase plan when deploying virtual machine from VM Marketplace images."
        },
        "properties": {
          "x-ms-client-flatten": true,
          "$ref": "#/definitions/VirtualMachineProperties"
        },
        "resources": {
          "readOnly": true,
          "type": "array",
          "items": {
            "$ref": "#/definitions/VirtualMachineExtension"
          },
          "description": "Gets the virtual machine child extension resources."
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/Resource"
        }
      ],
      "description": "Describes a Virtual Machine."
    },

ソースみたり原因さぐっていると、以下のIssueが見つかりました。どうも、そういうスキーマっぽい感じです。

Swagger is not parsing definitions with properties along with allOf · Issue #141 · swagger-api/swagger-parser · GitHub

AutoRestにも言及されていて、AutoRestのほうはヨロシクパースしてくれるんでしょうね、きっと。

というわけで、道半ばではありますが、備忘録変わりにBlogっておきます。Parserに手を入れて続けてみようかと。

Visual Studio Emacs Extension を入れた後にすること

Emacs VS

以前、こんな記事を書きましたが、いくつかカスタマイズした備忘録として。

statemachine.hatenablog.com

CTRL-K

Kill line の挙動が微妙です。二段階で消えるのが好みなのですが、何か文字があってもいきなり行が削除され、1行詰められてしまいました。

以下のPull Requestが取り込まれたので幾分ましになったような気がします。

Merge pull request #4 from genegoykhman/master · zbrad/EmacsKeys@c9ec52d · GitHub

がまだ不完全ぽくて、空の行が消えてくれません。

Home/End

Homeでファイル先頭、Endでファイル末尾に移動してしまいます。ここの挙動はWindows慣れしてしまっているので、CTRL-A、CTRL-Eと同じ動きをしてくれた方が自分好みです。オプションから適当に変更します。

Enter

Enter(改行)が「Emacs.編集の改行」に割り当たっています。このままだと、NugetのPowershellコンソールとかで、Enterが聞かなくなってしまいます。原因はよくわかってませんが。

なので、テキストエディターから、「Emacs.改行」のキーアサインを削除し、「編集.改行」へアサインしなおします。

f:id:StateMachine:20160425221100p:plain

とりあえず以上