openapi

README

GoREST OpenAPI Plugin

OpenAPI documentation plugin for GoREST framework.

Installation

go get github.com/nicolasbonnici/gorest-openapi

Usage

import (
	"github.com/nicolasbonnici/gorest/pluginloader"
	openapiplugin "github.com/nicolasbonnici/gorest-openapi"
)

func init() {
	pluginloader.RegisterPluginFactory("openapi", openapiplugin.NewPlugin)
}

Configuration

Add to your gorest.yaml:

plugins:
  - name: openapi
    enabled: true

Features

• Auto-generated OpenAPI 3.0 specification
• Interactive API documentation UI at /openapi
• OpenAPI JSON schema at /openapi.json
• Dynamic schema generation from database
• Scalar API reference integration

Endpoints

• GET /openapi - Interactive API documentation UI
• GET /openapi.json - OpenAPI 3.0 JSON schema

License

MIT License - see LICENSE file for details

Documentation

Index

• func NewPlugin() plugin.Plugin
• type GeneratorConfig
• type OpenAPIPlugin
  • func (p *OpenAPIPlugin) Handler() fiber.Handler
  • func (p *OpenAPIPlugin) Initialize(cfg map[string]interface{}) error
  • func (p *OpenAPIPlugin) Name() string
  • func (p *OpenAPIPlugin) SetupEndpoints(app *fiber.App) error

Functions

func NewPlugin

func NewPlugin() plugin.Plugin

Types

type GeneratorConfig

type GeneratorConfig struct {
	DTOsDirectory      string
	PaginationLimit    int
	PaginationMaxLimit int
}

type OpenAPIPlugin

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

func (*OpenAPIPlugin) Handler

func (p *OpenAPIPlugin) Handler() fiber.Handler

Handler returns a no-op middleware

func (*OpenAPIPlugin) Initialize

func (p *OpenAPIPlugin) Initialize(cfg map[string]interface{}) error

func (*OpenAPIPlugin) Name

func (p *OpenAPIPlugin) Name() string

func (*OpenAPIPlugin) SetupEndpoints

func (p *OpenAPIPlugin) SetupEndpoints(app *fiber.App) error

SetupEndpoints implements the EndpointSetup interface