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

# Functions

JSON 输出 JSON 格式数据.
YAML 输出 YAML 格式数据.

# Constants

LatestVersion openapi 最新的版本号.
Parameter.IN 的可选值.
Parameter.IN 的可选值.
Parameter.IN 的可选值.
Parameter.IN 的可选值.
SecurityScheme.IN 的可选值.
SecurityScheme.IN 的可选值.
SecurityScheme.IN 的可选值.
Security.Type 的可选值.
Security.Type 的可选值.
Security.Type 的可选值.
Security.Type 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Style.Style 的可选值.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.
Schema.Type 需要的一些预定义数据类型.

# Structs

Components 可复用的对象.
Contact 描述联系方式.
Discriminator Object NOTE: 暂时未用到。.
Encoding 定义编码 对父对象中的 Schema 中的一些字段的特殊定义.
Example 示例代码.
ExternalDocumentation 引用外部资源的扩展文档.
Info 接口文档的基本信息.
License 授权信息.
Link 链接信息.
MediaType 媒体类型.
OAuthFlow Object.
OAuthFlows Object.
OpenAPI openAPI 的根对象.
Operation 描述对某一个资源的操作具体操作.
Parameter 参数信息 可同时作用于路径参数、请求参数、报头内容和 Cookie 值。.
PathItem 每一条路径的详细描述信息.
RequestBody 请求内容.
Response 每个 API 的返回信息.
Schema 定义了输出和输出的数据类型.
SecurityScheme Object.
Server 服务器描述信息.
ServerVariable Server 中 URL 模板中对应的参数变量值.
Style 民法风格的相关定义 不直接作用于对象,被部分对象包含,比如 Encoding 和 Parameter 等.
Tag 标签内容.
XML 将 Schema 转换为 XML 的相关声明.

# Type aliases

Callback Object.
ExampleValue 表示示例的内容类型。.
Header 即 Parameter 的别名,但 Name 字段必须不能存在。.
SecurityRequirement Object 键名指向的是 Components.SecuritySchemes 中的名称。 若 SecurityScheme.Type 是 oauth2 或是 openIDConnect, 则 SecurityRequirement 的键值必须是个空值,否则键值为一个 scope 列表。.