0

aglio/api ブループリントを使用して、新しい API の優れたドキュメントを作成したいと考えています。

JSON は非常に大きくなる可能性があるため (多数のオプション値を含む)、本文で適切な使用例を示したいと思いますが、json スキーマのデータ構造も使用します。ただし、スキーマが本文に正確に適合する場合は常に、結果の HTML が「Hello, world!」をスローします。これは、例のデータを入力していないためです。ただし、本文には完全で有効な例があるため、 aglio が Hello World の出力を作成するとは思っていませんでした。

参考までに、結果の htmls 本文に表示されると予想されるのは次のとおりです。

{
    "a": "i want this to appear",
    "b": "in my aglio",
    "c": "html file"
}

実際に表示されるのは次のとおりです。

{
    "a": "Hello, world!",
    "b": "Hello, world!",
    "c": "Hello, world!",
    "d": "Hello, world!"
}

これが未加工の API の設計図です。

FORMAT: 1A

# JSON Schema

# Test [/post/something]

## A Test [POST]

+ Request (application/json)
    + Attributes (SomeObject)

    + Body

        {
          "a": "i want this to appear",
          "b": "in my aglio",
          "c": "html file"
        }

+ Response 200

# Data Structures
## SomeObject (object)
+ a (string) - A
+ b (string) - B
+ c (string) - C
+ d (string, optional) - I'm optional, yet don't want to appear in the html, only the schema

まず、それは有効な方法ですか? 別のアプローチをお勧めしますか？養蜂場では意図したとおりに機能するため、これは aglio のバグですか? ありがとう！

4

2 に答える 2

0

対応する github の問題が見つかりました。私の説明に問題はないようです。 https://github.com/danielgtaylor/aglio/issues/221

于 2016-07-20T13:56:14.670 に答える