我尝试使用apiblueprint来记录API,但我遇到了一个错误(在第31行),上面写着“悬空消息主体资产,预期是一个预先格式化的代码块,每行缩进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"
}发布于 2015-04-02 09:14:39
你的问题之一是使用锚点,特别是前面的那个:
2. G1资源2 /g1api2
你不需要这样做。如果您在没有这些锚点的情况下呈现文档,并查看左栏,您可以单击那里的链接。您将注意到浏览器地址栏中的相关片段。然后,您可以在标记链接中使用这些片段,如:
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将在左列为您呈现快捷方式,正如我上面所说的,您可以根据上面的示例在您自己的markdown链接中重用相关的片段。
https://stackoverflow.com/questions/29380085
复制相似问题