Apidoc — это простой инструмент для создания документации RESTful API, который извлекает информацию из комментариев к коду и генерирует документацию.
В настоящее время поддерживаются следующие языки: C#, C/C++, D, Dart, Erlang, Go, Groovy, Java, JavaScript, Julia, Lisp/Clojure, Lua, Nim, Pascal/Delphi, Perl, PHP, Python, Ruby, Rust, Scala, Swift, Typescript и Zig.
Дополнительную информацию можно найти на сайте apidoc.tools.
/**
* <api method="GET" summary="获取所有的用户信息">
* <path path="/users">
* <query name="page" type="number" default="0" summary="显示第几页的内容" />
* <query name="size" type="number" default="20" summary="每页显示的数量" />
* </path>
* <tag>user</tag>
* <server>users</server>
* <response status="200" type="object" mimetype="application/json">
* <param name="count" type="int" optional="false" summary="符合条件的所有用户数量" />
* <param name="users" type="object" array="true" summary="用户列表">
* <param name="id" type="int" summary="唯一 ID" />
* <param name="name" type="string" summary="姓名" />
* </param>
* <example mimetype="application/json">
* <![CDATA[
* {
* "count": 500,
* "users": [
* {"id":1, "name": "管理员2"},
* {"id":2, "name": "管理员2"}
* ],
* }
* ]]>
* </example>
* </response>
* <response status="500" mimetype="application/json" type="object">
* <param name="code" type="int" summary="错误代码" />
* <param name="msg" type="string" summary="错误内容" />
* </response>
* </api>
*/
func login(w http.ResponseWriter, r *http.Request) {
// TODO
}
На странице github.com/caixw/apidoc/releases доступны двоичные файлы для некоторых популярных систем. Если ваша система не поддерживается, вам придётся скачать и скомпилировать программу самостоятельно.
Поддерживается локализация на разных языках, которая настраивается автоматически в зависимости от языка вашей системы. В системах *nix вы можете изменить локализацию с помощью команды:
LANG=lang apidoc # lang — идентификатор нужного языка, например, zh-hans.
Более подробную информацию об установке и использовании можно найти на странице apidoc.tools/#usage.
Если вы хотите интегрировать apidoc в другое приложение на Go, вы можете использовать следующий код:
import (
"golang.org/x/text/language"
"github.com/caixw/apidoc/v7"
"github.com/caixw/apidoc/v7/core"
"github.com/caixw/apidoc/v7/build"
)
// 初始本地化内容
apidoc.SetLocale(language.MustParse("zh-Hans"))
// 可以自定义实现具体的错误处理方式
h := core.NewHandler(...)
output := &build.Output{...}
inputs := []*build.Input{...}
apidoc.Build(h, output, inputs...)
Подробнее см. в документации pkg.go.dev/github.com/caixw/apidoc/v7.
Пожалуйста, ознакомьтесь с файлом CONTRIBUTING.md.
Исходный код проекта лицензирован по лицензии MIT. Полную лицензию можно найти в файле LICENSE.
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Комментарии ( 0 )