api

API Documentation

This directory contains all API-related documentation for the FlowBot project.

File Descriptions

swagger.json & swagger.yaml

• OpenAPI 3.0 specification files
• Contains complete API interface definitions
• Supports multiple formats (JSON and YAML)

docs.go

• Go code automatically generated by the swaggo/swag tool
• Contains embedded API documentation definitions
• Used to provide Swagger UI at runtime

api.http

• Collection of HTTP request examples
• Can be run directly in VS Code or IntelliJ
• Contains test requests for various interfaces

Usage

View API Documentation

After starting the service, visit: http://localhost:8080/swagger/index.html

Generate/Update API Documentation

# Install swag tool
go install github.com/swaggo/swag/cmd/swag@latest

# Generate API documentation
swag init -g cmd/main.go

# Format API documentation
swag fmt -g cmd/main.go

API Overview

Main Modules

• dev - Development and debugging related interfaces
• okr - Objectives and Key Results management
• search - Search functionality
• user - User-related functionality
• workflow - Workflow management

Authentication

All APIs that require authentication use ApiKeyAuth authentication method:

Authorization: Bearer <your-token>