我正在尝试使用apiblueprint来记录API,但是我遇到了一个错误(第31行),该错误表示"悬空消息体资产,期望预先格式化的代码块,缩进其中的每一个' s行8个空格或2个标签"。我在添加目录后才开始看到此错误。
如果我删除第(34)行" ",然后错误消失了。可能是我在这里遗漏了一些东西,或者我可能不清楚。对它的任何帮助都很明显。感谢
以下是我的样本降价。
FORMAT: 1A
---
## [I. Introduction](#def-intro)
1. [Group 1](#def-g1)
1. [G1 Resource 1](#def-g1-res1)
2. [G1 Resource 2](#def-g1-res2)
2. [Group 2](#def-g2)
1. [G2 Resource 1](#def-g2-res1)
2. [G2 Resource 2](#def-g2-res2)
---
<a name="def-intro"> </a>
# I. Introduction
This is my test API
<a name="def-g1"> </a>
# 1. Group 1
This is group 1 API
<a name="def-g1-res1"> </a>
## 1. G1 Resource 1 [/g1api1]
### g1api1 [GET]
This is g1api1
+ Response 200 (application/json)
{
"response": "ok",
"resource": "g1api1"
}
<a name="def-g1-res1"> </a>
## 2. G1 Resource 2 [/g1api2]
This is g1api2
### g1api2 [GET]
+ Response 200 (application/json)
{
"response": "ok",
"resource": "g1api2"
}
答案 0 :(得分:0)
你的一个问题是使用锚点,特别是之前的锚点:
您不需要这样做。如果您在没有这些锚点的情况下渲染文档并查看左侧列,则可以单击其中的链接。您将在浏览器地址栏中注意到相关的片段。然后,您可以在降价链接中使用这些片段,如:
FORMAT: 1A
# My Api
This is my test API
## Table of Contents
1. [Introduction Section](#introduction/introduction-section)
1. [Group 1](#reference/one)
1. [G1 Resource 1](#reference/one/resource-1)
2. [G1 Resource 2](#reference/one/resource-2)
## Introduction Section
Blah Blah
# Group One
This is group 1 API
## Resource 1 [/g1api1]
### g1api1 [GET]
This is g1api1
+ Response 200 (application/json)
{
"response": "ok",
"resource": "g1api1"
}
## Resource 2 [/g1api2]
This is g1api2
### g1api2 [GET]
+ Response 200 (application/json)
{
"response": "ok",
"resource": "g1api2"
}
此外,它还可以帮助您阅读:https://apiary.io/blueprint
您不应该在“Group”和“Resource”关键字之前添加数字,因为它们必须首先定义这些部分。 Apiary将为您提供左栏中的快捷方式,正如我上面所述,您可以根据我上面的示例在您自己的降价链接中重复使用相关的片段。