2016-08-09 8 views
0

Dreddツールを使用してAPIをテストしています.io)。DreddがAPIドキュメントを見つけることができません。ローカルドライブ(apiary.ioサーバーにあります)にない場合はどうすればいいですか

質問

私は私のドキュメントへのパスでジャッジ・ドレッドを提供したいと考えが、しかし、私のAPIドキュメントがapiary.ioである(それもそれを要求)が、私は正確なURLを知りませんそれを指しています。 dreddにAPIのパスを提供する正しい方法は何でしょうか?私は自分のローカルドライブにAPIをダウンロードしたファイル(YMLまたはAPIB)へのローカルパスでジャッジ・ドレッドを提供しようとした:

注意(ただし私が探して)仕事をした何

これはうまく動作しますが(yay!)、ローカルコピーを残しておき、単純にapiaryサーバ上で管理されている私の実際のAPI文書の場所をdreddに提供しないようにしたいと思います。

ファイルをローカルドライブに最初にフェッチせずにこれを行うにはどうすればよいですか?以下のトピックに関する私も読んで(としようとした)

を失敗し、これを解決するために

試み、彼らが関連している可能性があるが、私は問題 の解決に成功しなかった - 環境変数として認証トークンを使用して - apiary.io//settingsによって提供されるドメインをdreddに提供する - dreddコマンドに を指定すると、これらのすべての試みは同じ結果を生成しますが、Dreddはパスを指定しない限りどこでAPIドキュメントを見つけるべきかわかりません私のローカルコンピュータをファイルにダウンロードしてください(私は自分のコンピュータで手動でダウンロードまたは作成する必要があります)。

ありがとうございました。

答えて

0

私が正しく理解している場合は、dreddを使用し、Apiar.ioプラットフォームにあるAPI記述文書を使用してフィードしますか?

もしそうなら、あなたは、単に右のオプションでinitコマンドを呼び出すことを行うことができるはず:

dredd init -r apiary -j apiaryApiKey:privateToken -j apiaryApiName:sasdasdasd

あなたはプライベートトークンがターゲットAPIのTestセクションに行く見つけることができます(アプリケーションヘッダーのボタンを見つけます)。

が、これはあなたのための問題を解決するかどうか、私に教えてください - 私はこれを伝播することを確認しますと、当社のヘルプページに応じて、それを文書化

PS:また、独自のレポーターを使用することができます - 単に、その場合にはコマンドラインパラメータを記述するときは-r apiaryを省略してください。

+0

Vincenzo、ご返信ありがとうございます。これは大丈夫APIドキュメントを特定しなければならない 、それでも_を入力するように私に尋ねジャッジ・ドレッド:養蜂場-jのapiaryApiKey -r ジャッジ・ドレッドの初期化: -j apiaryApiNameを私は実際にあなたが書いたものに似た、次のコマンドを書いていますか? API記述文書(apiary.apib)の場所_ このフィールドには何を入力しますか? (ちょうどdreddが設定されていないデフォルト値を得るためにenterを押すだけで、私のAPIの設定ウィンドウに提供されているドメインに入ってみました。 –

+0

こんにちは、 残念ながら私は間違いをしました - この機能はまだ利用できません。 [ここ](https://github.com/apiaryio/dredd/issues/366)に問題があり、現在作業中です。私は同僚の言葉を誤解した。 – Vincenzo

+0

今のところ私はapiary CLIを使用して最初にフェッチします。問題を参照してくれてありがとうございます。まずdreddをフェッチしてから実行することを避けるのがよいでしょう。 ありがとう –

0

Dreddには、ディスク上のファイルへのパスだけでなく、with an URLも入力できます。

ApiaryのAPIが公開されている場合は、APIの説明文書(この場合はAPIのBlueprint)に公開URLが必要です。たとえば、http://docs.apiblueprintapi.apiary.io/に行くと、左側にダウンロードリンクが表示されます。残念ながら、リンクはAPIのエディタにアクセスできないユーザーにしか表示されないため、APIの所有者であればリンクを見ることはできません。養蜂場からログアウトすると、リンクが表示されます試してみてください。

enter image description here

次にあなたがリンクでジャッジ・ドレッドを養うことができます。

$ dredd 'http://docs.apiblueprintapi.apiary.io/api-description-document' 'http://example.com:8080/api' 

私は、これは非常に直感的ではありません同意し、あなたがしているので、最初にこれを考え出すのではなく、もっと簡単にする方法をいくつか考えます。


APIが公開されていない場合は残念ながら、今のところURLを取得する方法はありません。ただし、GitHub SyncまたはApiary CLIのいずれかを使用して、ディスク上のファイルを自動化することができます。

+0

答えていただきありがとうございます、私は2つのオプション(githubまたはapiary CLI)のいずれかに行きます。 –

関連する問題