Openapi (Swagger) документации

Основные

OpenapiEnable используется для включения генерации Openapi документации.

// +build swipe
package example
import (  "github.com/example/app/pkg/controller"  "github.com/example/app/pkg/swipe/gokit")
func swipe() {    gokit.Gokit(        gokit.Interface((*controller.ExampleController)(nil), "example"),                gokit.HTTPServer(),                gokit.OpenapiEnable(),    )}

Документация будет сгенерирована в корень проекта.

Настройки

Изменение пути генерации

OpenapiOutput используется для изменения пути генерации Openapi документации.

// +build swipe
package example
import (  "github.com/example/app/pkg/controller"  "github.com/example/app/pkg/swipe/gokit")
func swipe() {    gokit.Gokit(        gokit.Interface((*controller.ExampleController)(nil), "example"),                gokit.HTTPServer(),                gokit.OpenapiEnable(),               gokit.OpenapiOutput("./docs") // путь указывается относительно корня проекта.                   )}

Установка информации

Вы можете установить заголовок, описание и версию с помощью функции OpenapiInfo.

// +build swipe
package example
import (  "github.com/example/app/pkg/controller"  "github.com/example/app/pkg/swipe/gokit")
func swipe() {    gokit.Gokit(                gokit.Interface((*controller.ExampleController)(nil), "example"),                       gokit.HTTPServer(),                       gokit.OpenapiEnable(),               gokit.OpenapiInfo("Service Name", "Service description", "v1.0.0"),                        )}

Установка контактов

Вы можете установить контакты, с помощью функции OpenapiContact.

// +build swipe
package example
import (  "github.com/example/app/pkg/controller"    "github.com/example/app/pkg/swipe/gokit")
func swipe() {    gokit.Gokit(        gokit.Interface((*controller.ExampleController)(nil), "example"),                gokit.HTTPServer(),                gokit.OpenapiEnable(),               gokit.OpenapiContact("John Doe", "jd@mail.com", "jd.com"),        gokit.OpenapiContact("No Name", "no@mail.com", ""),                 )}

Установка информации о серверах

Вы можете установить информацию о серверах, с помощью функции OpenapiServer.

package example
import (  "github.com/example/app/pkg/controller"    "github.com/example/app/pkg/swipe/gokit")
func swipe() {    gokit.Gokit(        gokit.Interface((*controller.ExampleController)(nil), "example"),                gokit.HTTPServer(),                gokit.OpenapiEnable(),               gokit.OpenapiServer("Test API", "http://api.test.com"),        gokit.OpenapiServer("Dev API", "http://api.dev.com"),                   )}