Device Connect API 仕様 (Swagger 2.0 形式)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
LICENSE
README.md

README.md

DeviceConnect-Spec

Device Connect API 仕様 (Swagger 2.0 形式)を定義したファイルを管理します。
ここで標準化した API を Device Connect は実装します。

Device Connect システムについては、こちらを参照してください。
Device Connect API の作成ガイドラインはこちらを参照してください。

ドキュメントの出力

ドキュメント作成において、以下のコマンドがインストールされていることを前提に説明を行います。

  • Java
  • cURL

DeviceConnect-Experiments から DeviceConnect Codegen をダウンロードします。

$ curl -LkO https://github.com/DeviceConnect/DeviceConnect-Experiments/releases/download/codegen-v1.0.0/deviceconnect-codegen-project-1.0.0.dist.zip
$ unzip deviceconnect-codegen-project-1.0.0.dist.zip

DeviceConnect-Spec から最新の定義ファイルをダウンロードします。

$ curl -o DeviceConnect-Spec.zip -LkO https://github.com/DeviceConnect/DeviceConnect-Spec/archive/master.zip
$ unzip DeviceConnect-Spec.zip

ダウンロードした定義ファイルからドキュメントを作成します。

$ java -Dfile.encoding=UTF-8 -jar ./deviceconnect-codegen-project-1.0.0/bin/deviceconnect-codegen.jar \
        --lang deviceConnectHtmlDocs \
        --display-name Device_Connect_RESTful_API_Specification \
        --input-spec-dir ./DeviceConnect-Spec-master/api \
        --output ./docs

実行すると--outputで指定したフォルダにDevice Connect APIのドキュメントが作成されます。

各オプションの説明

--input-spec-dir

定義ファイルが置いてあるフォルダを指定します。

--output

ドキュメントを出力する先のフォルダ名を指定します。
指定されたフォルダが存在しない場合には作成します。

--lang

ドキュメントを出力するので、deviceConnectHtmlDocsを指定します。

--display-name

ドキュメントのタイトルを指定します。

上記に記載したオプションが知りたい場合にはこちらを参照してください。