apidoc

package module
Version: v0.0.0-...-643d18f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2018 License: MIT Imports: 8 Imported by: 0

README

apidoc Build Status Go version Go Report Card license codecov

apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生成文档。 目前支持支持以下语言:C#、C/C++、D、Erlang、Go、Groovy、Java、JavaScript、Pascal/Delphi、 Perl、PHP、Python、Ruby、Rust、Scala 和 Swift。

具体文档可参考:https://apidoc.tools

/**
 * @api get /users 获取所有的用户信息
 * @apiTags users
 * @apiQuery page int 显示第几页的内容
 * @apiQuery size int 每页显示的数量
 *
 * @apiResponse 200 object application/json ok
 * @apiParam count int required 符合条件的所有用户数量
 * @apiParam users array.object required 用户列表。
 * @apiExample application/json
 * {
 *     "count": 500,
 *     "users": [
 *         {"id":1, "username": "admin1", "name": "管理员2"},
 *         {"id":2, "username": "admin2", "name": "管理员2"}
 *     ],
 * }
 * @apiExample application/xml
 * <users count="500">
 *     <user id="1" username="admin1" name="管理员1" />
 *     <user id="2" username="admin2" name="管理员2" />
 * </users>
 */
func login(w http.ResponseWriter, r *http.Request) {
    // TODO
}
安装
go get github.com/caixw/apidoc

支持多种本地化语言,默认情况下会根据当前系统所使用的语言进行调整。若需要手动指定, windows 可以设置一个 LANG 环境变量指定,*nix 系统可以使用以下命令:

LANG=lang apidoc

将其中的 lang 设置为你需要的语言。

集成

若需要将 apidoc 当作包集成到其它 Go 程序中,可参考以下代码:

// 初始本地化内容
apidoc.InitLocale()

// 可以自定义实现具体的错误处理方式
h := errors.NewHandler()

erro := log.NewLogger()
output := &output.Options{...}
inputs := []*input.Options{
    &input.Options{},
}

apidoc.Do(h, output, inputs...)
参与开发

请阅读 CONTRIBUTING.md 文件的相关内容。

版权

本项目采用 MIT 开源授权许可证,完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package apidoc RESTful API 文档生成工具。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Do

func Do(ctx context.Context, h *errors.Handler, output *options.Output, inputs ...*options.Input) error

Do 分析输入信息,并最终输出到指定的文件。

h 表示处理语法错误的处理器。 output 输出设置项; inputs 输入设置项。

func InitLocale

func InitLocale(tag language.Tag) error

InitLocale 初始化语言环境

NOTE: 必须保证在第一时间调用。

如果 tag 的值为 language.Und,则表示采用系统语言

func Version

func Version() string

Version 获取当前程序的版本号

Types

This section is empty.

Source Files

Directories

Path Synopsis
apidoc 是一个 RESTful API 文档生成工具。
apidoc 是一个 RESTful API 文档生成工具。
Package doc 表示最终解析出来的文档结果。
Package doc 表示最终解析出来的文档结果。
Package errors 公用的错误信息
Package errors 公用的错误信息
Package options 输入和输出的配置项
Package options 输入和输出的配置项
internal
input
Package input 用于处理输入的文件,从代码中提取基本的注释内容。
Package input 用于处理输入的文件,从代码中提取基本的注释内容。
lang
Package lang 各类语言解析和管理。
Package lang 各类语言解析和管理。
locale
Package locale 提供了一个本地化翻译服务。
Package locale 提供了一个本地化翻译服务。
locale/syslocale
Package syslocale 获取所在系统的本地化语言信息。
Package syslocale 获取所在系统的本地化语言信息。
output
Package output 对解析后的数据进行渲染输出。
Package output 对解析后的数据进行渲染输出。
output/openapi
Package openapi 实现 openapi 的相关数据类型 https://github.com/OAI/OpenAPI-Specification
Package openapi 实现 openapi 的相关数据类型 https://github.com/OAI/OpenAPI-Specification
vars
Package vars 提供了一些公共的函数、结构体及代码级别的设置项。
Package vars 提供了一些公共的函数、结构体及代码级别的设置项。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL