1

apiary向我展示了如何向参数添加描述。但是，我需要的是对值进行描述。

例如 /users{?skills}。这个参数我有我自己的技能代码

'1' 表示会说英语

'2' 表示会游泳

'3' 表示可以开车

在参数描述之后添加它们是一种方法。如果我有技能代码的音调怎么办？而且这种方法的格式很难看。我怎样才能实现它？

4

1 回答 1

0

目前没有办法通过使用 API Blueprint 的标准工具来实现。

两者都不

+ Values
    + `A - means something`
    + `B`
    + `C`

或者

+ Values
    + `A` means something
    + `B`
    + `C`

将正常工作。我在 API Blueprint 的存储库下提交了一个功能请求。如果您想参与设计过程并帮助我们为您的问题找到最佳解决方案，您可以跟踪它并在其下发表评论。

外貌

我知道在标准文档中呈现此功能不是很好。

在此处输入图像描述

但是，在“beta new docs”中，它看起来要好得多。试试看 - 在设置中，打开以下开关：

在此处输入图像描述

那么渲染应该是这样的（两种状态）：

在此处输入图像描述

在此处输入图像描述

使用表格

当 API 蓝图遇到问题时，您始终可以在端点描述中使用普通的旧 Markdown 来补充或替换缺少的内容。例如，您可以自由地使用表格作为该Values部分的补充或替换：

# My API

## Sample [/endpoint{?id}]

Description.

| Value        | Meaning          |
| ------------ |:----------------:|
| A            | Alaska           |
| B            | Bali             |
| C            | Czech Republic   |

+ Parameters

    + id (string)

        Description...

        | Value        | Meaning          |
        | ------------ |:----------------:|
        | A            | Alaska           |
        | B            | Bali             |
        | C            | Czech Republic   |

        Description...

        + Values
            + `A`
            + `B`
            + `C`

在新旧文档中呈现表格：

在此处输入图像描述

在此处输入图像描述

于 2014-09-09T14:22:37.297 回答