oapi_builder

package

v0.0.2 Latest Latest Go to latest Published: Apr 10, 2025 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type HandlersWithSchemas struct {
	MainInfoSchemas   Schemer
	PathSchemas       []Schemer
	ComponentsSchemas []Schemer
}

type OapiBuilder struct {
	// contains filtered or unexported fields
}

func New(logger *slog.Logger) *OapiBuilder

func (ob *OapiBuilder) AddComponentsSchemas(schemers []Schemer) *OapiBuilder

Example:

User:
	...
Error:
	...

func (ob *OapiBuilder) AddMainInfo(schemer Schemer) *OapiBuilder

Example:

openapi: 3.0.0
info:
	...
tags:
	...
servers:
	...

func (ob *OapiBuilder) AddPaths(schemers []Schemer) *OapiBuilder

Example:

  /api/v1/users:
    get:
		...
  /api/v1/users/{id}:
	put:
		...

AddPaths добавляет пути в спецификацию Сюда приходят схемы, в каждой из которых указан путь Мы вычисляем, какие пути уже есть и удаляем их из схем

func (ob *OapiBuilder) GetOapiInBytes() []byte

func (ob *OapiBuilder) MustGenerateSchemas(hws HandlersWithSchemas, saveTo string) *OapiBuilder

MustGenerateSchemas generate oapi specification and save to file as GenerateSchemas

Make panic if error

func (ob *OapiBuilder) PasteWithIndent(textWithNewLines string, deepLevel int) *OapiBuilder

func (ob *OapiBuilder) String() string

func (ob *OapiBuilder) ValidateAndGenerateYaml(path string) (string, error)

type Schemer interface {
	Scheme() string
}