package
6.0.1
Repository: https://github.com/caixw/apidoc.git
Documentation: pkg.go.dev

# Packages

Package doctest 提供了一个合法的 doc.Doc 对象.

# Functions

New 返回 Doc 实例.
Valid 验证文档内容的正确性.

# Constants

表示支持的各种数据类型.
表示支持的各种数据类型.
表示支持的各种数据类型.
表示支持的各种数据类型.
富文本可用的类型.
富文本可用的类型.
表示支持的各种数据类型.

# Structs

API 表示 <api> 顶层元素 <api method="GET" version="1.1.1" id="get-user"> <path path="/users/{id}"> <param name="id" type="number" summary="summary" /> </path> <tag>tag1</tag> <server>admin</server> ..
Callback 回调函数的定义 <Callback deprecated="1.1.1" method="GET"> <request status="200" mimetype="json" type="object"> <param name="name" type="string" /> <param name="sex" type="string"> <enum value="male" summary="male" /> <enum value="female" summary="female" /> </param> <param name="age" type="number" /> </request> </Callback>.
Contact 描述联系方式 <contact name="name"> <url>https://example.com</url> <email>[email protected]</email> </contact>.
Doc 文档.
Enum 表示枚举值 <enum value="male" summary="男性" /> <enum value="female"><description type="html"><p>女性</p></description></enum>.
Example 示例代码.
Link 表示一个链接 <link url="https://example.com" text="text" />.
Param 表示参数类型 <param name="user" deprecated="1.1.1" type="object" array="true"> <param name="name" type="string" /> <param name="sex" type="string"> <enum value="male" summary="male" /> <enum value="female" summary="female" /> </param> <param name="age" type="number" /> </param>.
Path 路径信息 <path path="/users/{id}"> <param name="id" type="number" summary="summary" /> <query name="page" type="number" summary="page" default="1" /> </path>.
Request 请求内容.
Richtext 富文本内容.
Server 服务信息 <server name="tag1" deprecated="1.1.1" url="api.example.com/admin" summary="description" />.
Tag 标签内容 <tag name="tag1" deprecated="1.1.1" />.
XML 仅作用于 XML 的几个属性.

# Type aliases

Method 表示请求方法.
Status 表示 HTTP 状态码.
Type 表示参数类型.
Version 版本号.