問題タブ [apiblueprint]

ここ数日、API ブループリント、RAML、または Swagger を使用する必要があるかどうかを理解しようと努めてきました。

swagger には最大のコミュニティがあるように見えますが、よく見るとドキュメンテーションが大幅に不足しているように感じます (コードを何度も見て、現在のプロジェクトに統合することを余儀なくされました)、多くの github の問題とスタックオーバーフロー質問は未回答です。

ここで何かが足りない可能性はありますか? 私が欲しいのは、API ドキュメントを作成し、エンドポイントをテストするのに役立つツールだけです。

なぜ闊歩をサーバーロジックの一部にする必要があるのですか?? エディターでswaggerファイルを作成し、それらをUIに直接提供すると、壊れます..

私が知る限り、それはサーバーをわずかに遅くし、不器用に維持された多くの統合の存在を強制します:p ここで何が欠けていますか?

accounts「名前」または「ステータス」に基づいて「 」を検索 (たとえば) したい。

だから私は2つのアクションをしたいと思います:

• GET /persons/?q=name==Jea*
• GET /persons/?q=status==locked

どうすればそれを文書化できますか?

複数のトランザクションでアクションを試しました：

しかし、Apiary エディターは次の理由で文句を言います。

1. GET リクエストにメッセージ本文を提供する必要があります。

   メッセージ本文のアセットは、各行が正確に 8 つのスペースまたは 2 つのタブでインデントされた、事前にフォーマットされたコード ブロックであることが期待されます。

2. + Parametersブロックが認識されません:

   認識されないブロックを無視する

どうもありがとう

問題：

Swagger、RAML、または API ブループリント入力の HTML 表現を生成できる Java または JavaScript (またはおそらく Scala) のライブラリを探しています。

バックグラウンド：

アイデアは、API カタログとして機能する (Play Framework) Web アプリの一部として使用することです。API 仕様は API カタログのユーザーによって追加され、結果の HTML 表現が生成/表示されます。

API 仕様スタブも Java API を使用して作成できれば、さらに価値があります。API カタログ Web アプリには、API スタブを生成するときに使用したいデータ モデルがあります。

さらに、同じ (または関連する別の) ライブラリが、編集中にユーザーをサポートする API 仕様言語 (Swagger、RAML、API Blueprint など) の優れた HTML エディターを提供する場合、追加の価値が得られます。

私は API を作成しようとしていますが、カスタム アクションをリソースに追加する良い方法を見つけるのに苦労しています。たとえば、私のユーザー リソースでは、アクションenabledとが必要ですdisableが、通常のブループリント グループ内では、これらをグループに追加することはできません。

ここでは、Disable a UserとUpdate a Userの両方が同じ URL を指していますが、これは私が望んでいるものではありません。/users/{id}これらでそれぞれ URLとを生成したいと考えています/users/{id}/disable。

他の API ソースを見ると、他の人は名前付きリソースを使用せずにそれを行っており、次のようになります。

このアプローチを使用することもできますが、ほとんどのブループリント ツールでレンダリングしたときにきれいになるため、最初のアプローチを使用することをお勧めします。

最初のアプローチを使用してカスタムアクションを実行する方法はありますか、または他の誰かが同じ種類のものを実装するよりクリーンな方法を持っていますか?

私のブループリントには、必須パラメーターとして定義されている GET アクションのアクション パラメーターがあります。ただし、パラメーターなしでモック サービス エンドポイントを呼び出すと、正当な応答が返されます。定義されたアクション パラメータの制約に対応する実行時の強制はありますか?

iOS から apiary サーバーに単純な json オブジェクトを送信しようとしています。作成後にjsonオブジェクトを印刷すると、すべてがうまく見えます。しかし、養蜂場はすべてが混同されていることを示しています。アイテムが 1 つしかない場合は、問題ないように見えます。

ここで、オブジェクトを作成してエンコードします

次に、AFNetworking を使用してデータを送信します

取得したデコードされた json オブジェクトをログに記録する

最後に、養蜂場で次のようになります

jsonはすべて混同されています。AFNetworking が原因なのか、養蜂場が混同しているのかはわかりませんが、実際のサーバーにはこの問題がないため、心配する必要はありません。

最後に、養蜂場の設定方法は次のとおりです

私がやっている疑わしいことを見た人はいますか？ありがとうございました

ああ、物事を混同することに加えて、json にはデータが繰り返されています。