mirror of
https://github.com/danielmiessler/Fabric.git
synced 2026-01-10 06:48:04 -05:00
docs: Add YouTube transcript endpoint to Swagger UI.
- Add `/youtube/transcript` POST endpoint to Swagger docs - Define `YouTubeRequest` schema with URL, language, timestamps fields - Define `YouTubeResponse` schema with transcript and metadata fields - Add API security requirement using ApiKeyAuth - Document 200, 400, and 500 response codes - Add godoc comments to YouTubeHandler struct methods - Include example values for all request/response properties
This commit is contained in:
Kayvan Sylvan
105
docs/docs.go
105
docs/docs.go
@@ -214,6 +214,63 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/youtube/transcript": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"ApiKeyAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Retrieves the transcript of a YouTube video along with video metadata (title and description)",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"youtube"
|
||||
],
|
||||
"summary": "Get YouTube video transcript",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "YouTube transcript request with URL, language, and timestamp options",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/restapi.YouTubeRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful response with transcript and metadata",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/restapi.YouTubeResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request - invalid URL or playlist URL provided",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error - failed to retrieve transcript or metadata",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
@@ -401,6 +458,54 @@ const docTemplate = `{
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"restapi.YouTubeRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"url"
|
||||
],
|
||||
"properties": {
|
||||
"language": {
|
||||
"description": "Language code for transcript (default: \"en\")",
|
||||
"type": "string",
|
||||
"example": "en"
|
||||
},
|
||||
"timestamps": {
|
||||
"description": "Include timestamps in the transcript (default: false)",
|
||||
"type": "boolean",
|
||||
"example": false
|
||||
},
|
||||
"url": {
|
||||
"description": "YouTube video URL (required)",
|
||||
"type": "string",
|
||||
"example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
|
||||
}
|
||||
}
|
||||
},
|
||||
"restapi.YouTubeResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Video description from YouTube metadata",
|
||||
"type": "string",
|
||||
"example": "This is the video description from YouTube..."
|
||||
},
|
||||
"title": {
|
||||
"description": "Video title from YouTube metadata",
|
||||
"type": "string",
|
||||
"example": "Example Video Title"
|
||||
},
|
||||
"transcript": {
|
||||
"description": "The video transcript text",
|
||||
"type": "string",
|
||||
"example": "This is the video transcript..."
|
||||
},
|
||||
"videoId": {
|
||||
"description": "YouTube video ID",
|
||||
"type": "string",
|
||||
"example": "dQw4w9WgXcQ"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securityDefinitions": {
|
||||
|
||||
@@ -208,6 +208,63 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/youtube/transcript": {
|
||||
"post": {
|
||||
"security": [
|
||||
{
|
||||
"ApiKeyAuth": []
|
||||
}
|
||||
],
|
||||
"description": "Retrieves the transcript of a YouTube video along with video metadata (title and description)",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"youtube"
|
||||
],
|
||||
"summary": "Get YouTube video transcript",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "YouTube transcript request with URL, language, and timestamp options",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/restapi.YouTubeRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful response with transcript and metadata",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/restapi.YouTubeResponse"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request - invalid URL or playlist URL provided",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error - failed to retrieve transcript or metadata",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
@@ -395,6 +452,54 @@
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"restapi.YouTubeRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"url"
|
||||
],
|
||||
"properties": {
|
||||
"language": {
|
||||
"description": "Language code for transcript (default: \"en\")",
|
||||
"type": "string",
|
||||
"example": "en"
|
||||
},
|
||||
"timestamps": {
|
||||
"description": "Include timestamps in the transcript (default: false)",
|
||||
"type": "boolean",
|
||||
"example": false
|
||||
},
|
||||
"url": {
|
||||
"description": "YouTube video URL (required)",
|
||||
"type": "string",
|
||||
"example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
|
||||
}
|
||||
}
|
||||
},
|
||||
"restapi.YouTubeResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Video description from YouTube metadata",
|
||||
"type": "string",
|
||||
"example": "This is the video description from YouTube..."
|
||||
},
|
||||
"title": {
|
||||
"description": "Video title from YouTube metadata",
|
||||
"type": "string",
|
||||
"example": "Example Video Title"
|
||||
},
|
||||
"transcript": {
|
||||
"description": "The video transcript text",
|
||||
"type": "string",
|
||||
"example": "This is the video transcript..."
|
||||
},
|
||||
"videoId": {
|
||||
"description": "YouTube video ID",
|
||||
"type": "string",
|
||||
"example": "dQw4w9WgXcQ"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securityDefinitions": {
|
||||
|
||||
@@ -127,6 +127,42 @@ definitions:
|
||||
description: '"content", "error", "complete"'
|
||||
type: string
|
||||
type: object
|
||||
restapi.YouTubeRequest:
|
||||
properties:
|
||||
language:
|
||||
description: 'Language code for transcript (default: "en")'
|
||||
example: en
|
||||
type: string
|
||||
timestamps:
|
||||
description: 'Include timestamps in the transcript (default: false)'
|
||||
example: false
|
||||
type: boolean
|
||||
url:
|
||||
description: YouTube video URL (required)
|
||||
example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
||||
type: string
|
||||
required:
|
||||
- url
|
||||
type: object
|
||||
restapi.YouTubeResponse:
|
||||
properties:
|
||||
description:
|
||||
description: Video description from YouTube metadata
|
||||
example: This is the video description from YouTube...
|
||||
type: string
|
||||
title:
|
||||
description: Video title from YouTube metadata
|
||||
example: Example Video Title
|
||||
type: string
|
||||
transcript:
|
||||
description: The video transcript text
|
||||
example: This is the video transcript...
|
||||
type: string
|
||||
videoId:
|
||||
description: YouTube video ID
|
||||
example: dQw4w9WgXcQ
|
||||
type: string
|
||||
type: object
|
||||
host: localhost:8080
|
||||
info:
|
||||
contact:
|
||||
@@ -262,6 +298,44 @@ paths:
|
||||
summary: Apply pattern with variables
|
||||
tags:
|
||||
- patterns
|
||||
/youtube/transcript:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
description: Retrieves the transcript of a YouTube video along with video metadata
|
||||
(title and description)
|
||||
parameters:
|
||||
- description: YouTube transcript request with URL, language, and timestamp
|
||||
options
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/restapi.YouTubeRequest'
|
||||
produces:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: Successful response with transcript and metadata
|
||||
schema:
|
||||
$ref: '#/definitions/restapi.YouTubeResponse'
|
||||
"400":
|
||||
description: Bad request - invalid URL or playlist URL provided
|
||||
schema:
|
||||
additionalProperties:
|
||||
type: string
|
||||
type: object
|
||||
"500":
|
||||
description: Internal server error - failed to retrieve transcript or metadata
|
||||
schema:
|
||||
additionalProperties:
|
||||
type: string
|
||||
type: object
|
||||
security:
|
||||
- ApiKeyAuth: []
|
||||
summary: Get YouTube video transcript
|
||||
tags:
|
||||
- youtube
|
||||
securityDefinitions:
|
||||
ApiKeyAuth:
|
||||
in: header
|
||||
|
||||
@@ -12,17 +12,19 @@ type YouTubeHandler struct {
|
||||
yt *youtube.YouTube
|
||||
}
|
||||
|
||||
// YouTubeRequest represents a request to get a YouTube video transcript
|
||||
type YouTubeRequest struct {
|
||||
URL string `json:"url"`
|
||||
Language string `json:"language"`
|
||||
Timestamps bool `json:"timestamps"`
|
||||
URL string `json:"url" binding:"required" example:"https://www.youtube.com/watch?v=dQw4w9WgXcQ"` // YouTube video URL (required)
|
||||
Language string `json:"language,omitempty" example:"en"` // Language code for transcript (default: "en")
|
||||
Timestamps bool `json:"timestamps,omitempty" example:"false"` // Include timestamps in the transcript (default: false)
|
||||
}
|
||||
|
||||
// YouTubeResponse represents the response containing video transcript and metadata
|
||||
type YouTubeResponse struct {
|
||||
Transcript string `json:"transcript"`
|
||||
VideoId string `json:"videoId"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Transcript string `json:"transcript" example:"This is the video transcript..."` // The video transcript text
|
||||
VideoId string `json:"videoId" example:"dQw4w9WgXcQ"` // YouTube video ID
|
||||
Title string `json:"title" example:"Example Video Title"` // Video title from YouTube metadata
|
||||
Description string `json:"description" example:"This is the video description from YouTube..."` // Video description from YouTube metadata
|
||||
}
|
||||
|
||||
func NewYouTubeHandler(r *gin.Engine, registry *core.PluginRegistry) *YouTubeHandler {
|
||||
@@ -31,6 +33,18 @@ func NewYouTubeHandler(r *gin.Engine, registry *core.PluginRegistry) *YouTubeHan
|
||||
return handler
|
||||
}
|
||||
|
||||
// Transcript godoc
|
||||
// @Summary Get YouTube video transcript
|
||||
// @Description Retrieves the transcript of a YouTube video along with video metadata (title and description)
|
||||
// @Tags youtube
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param request body YouTubeRequest true "YouTube transcript request with URL, language, and timestamp options"
|
||||
// @Success 200 {object} YouTubeResponse "Successful response with transcript and metadata"
|
||||
// @Failure 400 {object} map[string]string "Bad request - invalid URL or playlist URL provided"
|
||||
// @Failure 500 {object} map[string]string "Internal server error - failed to retrieve transcript or metadata"
|
||||
// @Security ApiKeyAuth
|
||||
// @Router /youtube/transcript [post]
|
||||
func (h *YouTubeHandler) Transcript(c *gin.Context) {
|
||||
var req YouTubeRequest
|
||||
if err := c.BindJSON(&req); err != nil {
|
||||
@@ -57,10 +71,18 @@ func (h *YouTubeHandler) Transcript(c *gin.Context) {
|
||||
return
|
||||
}
|
||||
|
||||
// Try to get metadata (requires valid YouTube API key), but don't fail if unavailable
|
||||
// This allows the endpoint to work for transcript extraction even without API key
|
||||
var metadata *youtube.VideoMetadata
|
||||
if metadata, err = h.yt.GrabMetadata(videoID); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
var title, description string
|
||||
if metadata, err = h.yt.GrabMetadata(videoID); err == nil {
|
||||
// Metadata available - use title and description from API
|
||||
title = metadata.Title
|
||||
description = metadata.Description
|
||||
} else {
|
||||
// No valid API key or metadata fetch failed - fallback to videoID as title
|
||||
title = videoID
|
||||
description = ""
|
||||
}
|
||||
|
||||
var transcript string
|
||||
@@ -74,5 +96,5 @@ func (h *YouTubeHandler) Transcript(c *gin.Context) {
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, YouTubeResponse{Transcript: transcript, VideoId: videoID, Title: metadata.Title, Description: metadata.Description})
|
||||
c.JSON(http.StatusOK, YouTubeResponse{Transcript: transcript, VideoId: videoID, Title: title, Description: description})
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user