api

Documentation

Index

• Constants
• func SetupRoutes(router *gin.RouterGroup, storage *storage.MemoryStorage, logger *logger.Logger)
• func WriteJSONError(w http.ResponseWriter, err APIError)
• type APIError
  • func NewAPIError(code int, message string) APIError
  • func (e APIError) Error() string
• type Handler
  • func NewHandler(storage *storage.MemoryStorage, logger *logger.Logger, ...) *Handler
  • func (h *Handler) AddOntology(c *gin.Context)
  • func (h *Handler) DeleteOntology(c *gin.Context)
  • func (h *Handler) ElementDetailsHandler(c *gin.Context)
  • func (h *Handler) GetElementContexts(c *gin.Context)
  • func (h *Handler) GetElementRelations(c *gin.Context)
  • func (h *Handler) GetOntology(c *gin.Context)
  • func (h *Handler) GetOntologyFiles(c *gin.Context)
  • func (h *Handler) GetOntologyMetadata(c *gin.Context)
  • func (h *Handler) ListOntologies(c *gin.Context)
  • func (h *Handler) LoadOntology(c *gin.Context)
  • func (h *Handler) SearchOntologies(c *gin.Context)
  • func (h *Handler) UpdateOntology(c *gin.Context)
  • func (h *Handler) ViewSourceFile(c *gin.Context)
• type UniqueResult

Constants

const (
	ErrBadRequest          = 400
	ErrNotFound            = 404
	ErrInternalServerError = 500
)

Constantes pour les codes d'erreur

const (
	MsgInvalidInput        = "Invalid input provided"
	MsgResourceNotFound    = "Requested resource not found"
	MsgInternalServerError = "An internal server error occurred"
)

Constantes pour les messages d'erreur communs

Functions

func SetupRoutes

func SetupRoutes(router *gin.RouterGroup, storage *storage.MemoryStorage, logger *logger.Logger)

func WriteJSONError

func WriteJSONError(w http.ResponseWriter, err APIError)

WriteJSONError écrit une réponse d'erreur JSON

Types

type APIError

type APIError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

APIError représente une erreur de l'API

func NewAPIError

func NewAPIError(code int, message string) APIError

NewAPIError crée une nouvelle instance de APIError

func (APIError) Error

func (e APIError) Error() string

type Handler

type Handler struct {
	Storage *storage.MemoryStorage
	Logger  *logger.Logger
	Search  *search.SearchEngine
}

Handler encapsule les dépendances nécessaires pour gérer les requêtes API

func NewHandler

func NewHandler(storage *storage.MemoryStorage, logger *logger.Logger, search *search.SearchEngine) *Handler

NewHandler crée une nouvelle instance de Handler avec le stockage, le logger et le moteur de recherche fournis

func (*Handler) AddOntology

func (h *Handler) AddOntology(c *gin.Context)

AddOntology ajoute une nouvelle ontologie

func (*Handler) DeleteOntology

func (h *Handler) DeleteOntology(c *gin.Context)

DeleteOntology supprime une ontologie par son ID

func (*Handler) ElementDetailsHandler

func (h *Handler) ElementDetailsHandler(c *gin.Context)

ElementDetailsHandler récupère les détails d'un élément spécifique

func (*Handler) GetElementContexts

func (h *Handler) GetElementContexts(c *gin.Context)

func (*Handler) GetElementRelations

func (h *Handler) GetElementRelations(c *gin.Context)

GetElementRelations récupère les relations d'un élément spécifique

func (*Handler) GetOntology

func (h *Handler) GetOntology(c *gin.Context)

GetOntology récupère une ontologie par son ID

func (*Handler) GetOntologyFiles

func (h *Handler) GetOntologyFiles(c *gin.Context)

GetOntologyFiles récupère la liste des fichiers de toutes les ontologies

func (*Handler) GetOntologyMetadata

func (h *Handler) GetOntologyMetadata(c *gin.Context)

Ajouter un endpoint pour récupérer les métadonnées d'une ontologie

func (*Handler) ListOntologies

func (h *Handler) ListOntologies(c *gin.Context)

ListOntologies récupère la liste de toutes les ontologies

func (*Handler) LoadOntology

func (h *Handler) LoadOntology(c *gin.Context)

func (*Handler) SearchOntologies

func (h *Handler) SearchOntologies(c *gin.Context)

SearchOntologies effectue une recherche dans les ontologies

func (*Handler) UpdateOntology

func (h *Handler) UpdateOntology(c *gin.Context)

UpdateOntology met à jour une ontologie existante

func (*Handler) ViewSourceFile

func (h *Handler) ViewSourceFile(c *gin.Context)

ViewSourceFile gère l'affichage des fichiers source

type UniqueResult

type UniqueResult struct {
	ElementName    string
	ElementType    string
	Description    string
	OntologyID     string
	Contexts       []models.JSONContext
	FileID         string
	SourceFile     string
	SourceMetadata *models.SourceMetadata
}