Cloud Endpoint (Java) から生成されたファイルから、読み取り可能な形式で API ドキュメントを生成する効率的な方法を探しています。生成されるファイルは次のいずれかです。 - my_api.api - my_api*.discovery
次のようなもの: - https://github.com/kevinrenskers/raml2html#example-output
Swagger、API ブループリント、および RAML はすべて適切なオプションですが、エンドポイントで生成された API 記述子ファイルにはうまく適応していないようです。
どのような方法を使用していますか?
残念ながら、私たち (Apiary) は現在、API ブループリント用のコード生成ツールを提供していません。
コードから API の説明を生成する方法を探している場合、API ブループリントはおそらく最良の選択ではありません。なぜなら、API 設計ライフサイクルに関与するすべての人の間の契約を表す必要があるからです。これは、テスト ツール – Dredd – https://github.com/apiaryio/dreddを作成した理由でもあります。
Dredd を使用すると、API 実装が設計図と一致しているかどうかをテストできます。設計図が実装から生成されるとしたら、あまり意味がありません。
それが明確になることを願っています。